From becec8500ed7275fa29a38d2bcc4fd032b17f401 Mon Sep 17 00:00:00 2001 From: Dhaval Brahmbhatt <32913565+dbbrahmbhatt@users.noreply.github.com> Date: Fri, 15 May 2020 14:00:34 -0700 Subject: [PATCH] Version 4.3.0-rc (#99) Co-authored-by: Dhaval Brahmbhatt <dhaval.brahmbhatt@dsa017178.docusignhq.com> --- src/Api/AccountsApi.php | 210 +++++++- src/Api/AuthenticationApi.php | 30 +- src/Api/BillingApi.php | 50 +- src/Api/BulkEnvelopesApi.php | 26 +- src/Api/CloudStorageApi.php | 30 +- src/Api/ConnectApi.php | 74 ++- src/Api/CustomTabsApi.php | 22 +- src/Api/DiagnosticsApi.php | 30 +- src/Api/EnvelopesApi.php | 338 ++++++++++++- src/Api/FoldersApi.php | 18 +- src/Api/GroupsApi.php | 42 +- src/Api/NotaryApi.php | 6 +- src/Api/OrganizationsApi.php | 10 +- src/Api/PowerFormsApi.php | 34 +- src/Api/SigningGroupsApi.php | 38 +- src/Api/TemplatesApi.php | 194 +++++++- src/Api/UsersApi.php | 122 ++++- src/Api/WorkspacesApi.php | 46 +- src/HeaderSelector.php | 109 +++++ src/Model/AccountAddress.php | 157 +++++- src/Model/AccountBillingPlan.php | 189 +++++++- src/Model/AccountBillingPlanResponse.php | 147 +++++- .../AccountIdentityVerificationResponse.php | 113 ++++- src/Model/AccountIdentityVerificationStep.php | 117 ++++- .../AccountIdentityVerificationWorkflow.php | 121 ++++- src/Model/AccountInformation.php | 237 ++++++++- src/Model/AccountMinimumPasswordLength.php | 117 ++++- .../AccountPasswordExpirePasswordDays.php | 117 ++++- .../AccountPasswordLockoutDurationMinutes.php | 117 ++++- .../AccountPasswordLockoutDurationType.php | 113 ++++- .../AccountPasswordMinimumPasswordAgeDays.php | 117 ++++- .../AccountPasswordQuestionsRequired.php | 117 ++++- src/Model/AccountPasswordRules.php | 203 ++++++-- src/Model/AccountPasswordStrengthType.php | 113 ++++- .../AccountPasswordStrengthTypeOption.php | 137 +++++- src/Model/AccountRoleSettings.php | 459 +++++++++++++++--- src/Model/AccountSeals.php | 113 ++++- src/Model/AccountSettingsInformation.php | 113 ++++- src/Model/AccountSharedAccess.php | 147 +++++- src/Model/AccountSignatureProvider.php | 137 +++++- src/Model/AccountSignatureProviderOption.php | 121 ++++- src/Model/AccountSignatureProviders.php | 113 ++++- src/Model/AddOn.php | 125 ++++- src/Model/AddressInformation.php | 179 ++++++- src/Model/AddressInformationInput.php | 123 ++++- src/Model/AddressInformationV2.php | 141 +++++- src/Model/Agent.php | 333 +++++++++++-- src/Model/ApiRequestLog.php | 125 ++++- src/Model/ApiRequestLogsResult.php | 113 ++++- src/Model/AppStoreProduct.php | 117 ++++- src/Model/AppStoreReceipt.php | 117 ++++- src/Model/Approve.php | 253 +++++++++- src/Model/Attachment.php | 137 +++++- src/Model/AuthenticationMethod.php | 125 ++++- src/Model/AuthenticationStatus.php | 223 +++++++-- src/Model/BccEmailAddress.php | 117 ++++- src/Model/BillingCharge.php | 161 +++++- src/Model/BillingChargeResponse.php | 113 ++++- src/Model/BillingDiscount.php | 121 ++++- src/Model/BillingInvoice.php | 149 +++++- src/Model/BillingInvoiceItem.php | 129 ++++- src/Model/BillingInvoicesResponse.php | 121 ++++- src/Model/BillingInvoicesSummary.php | 121 ++++- src/Model/BillingPayment.php | 121 ++++- src/Model/BillingPaymentItem.php | 129 ++++- src/Model/BillingPaymentRequest.php | 113 ++++- src/Model/BillingPaymentResponse.php | 113 ++++- src/Model/BillingPaymentsResponse.php | 121 ++++- src/Model/BillingPlan.php | 169 ++++++- src/Model/BillingPlanInformation.php | 185 ++++++- src/Model/BillingPlanPreview.php | 135 +++++- src/Model/BillingPlanResponse.php | 119 ++++- src/Model/BillingPlanUpdateResponse.php | 143 +++++- src/Model/BillingPlansResponse.php | 113 ++++- src/Model/BillingPrice.php | 121 ++++- src/Model/Brand.php | 167 ++++++- src/Model/BrandEmailContent.php | 125 ++++- src/Model/BrandLink.php | 125 ++++- src/Model/BrandLogos.php | 121 ++++- src/Model/BrandRequest.php | 113 ++++- src/Model/BrandResourceUrls.php | 125 ++++- src/Model/BrandResources.php | 141 +++++- src/Model/BrandResourcesList.php | 113 ++++- src/Model/BrandsRequest.php | 113 ++++- src/Model/BrandsResponse.php | 121 ++++- src/Model/BulkEnvelope.php | 147 +++++- src/Model/BulkEnvelopeStatus.php | 165 ++++++- src/Model/BulkEnvelopesResponse.php | 137 +++++- src/Model/BulkRecipient.php | 149 +++++- src/Model/BulkRecipientSignatureProvider.php | 117 ++++- src/Model/BulkRecipientTabLabel.php | 117 ++++- src/Model/BulkRecipientsRequest.php | 113 ++++- src/Model/BulkRecipientsResponse.php | 137 +++++- src/Model/BulkRecipientsSummaryResponse.php | 125 ++++- src/Model/BulkRecipientsUpdateResponse.php | 115 ++++- src/Model/CaptiveRecipient.php | 127 ++++- src/Model/CaptiveRecipientInformation.php | 113 ++++- src/Model/CarbonCopy.php | 323 ++++++++++-- src/Model/CertifiedDelivery.php | 323 ++++++++++-- src/Model/Checkbox.php | 241 ++++++++- src/Model/ChunkedUploadPart.php | 117 ++++- src/Model/ChunkedUploadRequest.php | 117 ++++- src/Model/ChunkedUploadResponse.php | 145 +++++- src/Model/CloudStorageProvider.php | 131 ++++- src/Model/CloudStorageProviders.php | 113 ++++- src/Model/Company.php | 277 ++++++++++- src/Model/CompositeTemplate.php | 131 ++++- src/Model/ConnectConfigResults.php | 117 ++++- src/Model/ConnectCustomConfiguration.php | 197 +++++++- src/Model/ConnectDebugLog.php | 131 ++++- src/Model/ConnectFailureFilter.php | 117 ++++- src/Model/ConnectFailureResult.php | 129 ++++- src/Model/ConnectFailureResults.php | 113 ++++- src/Model/ConnectLog.php | 181 ++++++- src/Model/ConnectLogs.php | 125 ++++- src/Model/ConsoleViewRequest.php | 117 ++++- src/Model/ConsumerDisclosure.php | 241 ++++++++- src/Model/Contact.php | 151 +++++- src/Model/ContactGetResponse.php | 137 +++++- src/Model/ContactModRequest.php | 113 ++++- src/Model/ContactPhoneNumber.php | 117 ++++- src/Model/ContactUpdateResponse.php | 113 ++++- src/Model/CorrectViewRequest.php | 117 ++++- src/Model/Country.php | 125 ++++- src/Model/CreditCardInformation.php | 135 +++++- src/Model/CreditCardTypes.php | 113 ++++- src/Model/CurrencyFeatureSetPrice.php | 129 ++++- src/Model/CurrencyPlanPrice.php | 135 +++++- src/Model/CustomField.php | 143 +++++- src/Model/CustomFieldV2.php | 139 +++++- src/Model/CustomFields.php | 117 ++++- src/Model/CustomFieldsEnvelope.php | 117 ++++- src/Model/CustomSettingsInformation.php | 113 ++++- src/Model/Date.php | 301 +++++++++++- src/Model/DateSigned.php | 249 +++++++++- src/Model/DateStampProperties.php | 125 ++++- src/Model/Decline.php | 257 +++++++++- src/Model/DiagnosticsSettingsInformation.php | 121 ++++- src/Model/DobInformationInput.php | 121 ++++- src/Model/Document.php | 199 +++++++- src/Model/DocumentFieldsInformation.php | 113 ++++- ...DocumentHtmlCollapsibleDisplaySettings.php | 149 +++++- src/Model/DocumentHtmlDefinition.php | 153 +++++- src/Model/DocumentHtmlDefinitionOriginal.php | 123 ++++- src/Model/DocumentHtmlDefinitionOriginals.php | 113 ++++- src/Model/DocumentHtmlDefinitions.php | 113 ++++- src/Model/DocumentHtmlDisplayAnchor.php | 135 +++++- src/Model/DocumentHtmlDisplaySettings.php | 159 +++++- src/Model/DocumentTemplate.php | 131 ++++- src/Model/DocumentTemplateList.php | 113 ++++- src/Model/DocumentVisibility.php | 131 ++++- src/Model/DocumentVisibilityList.php | 113 ++++- src/Model/ENoteConfiguration.php | 129 ++++- src/Model/Editor.php | 329 +++++++++++-- src/Model/Email.php | 301 +++++++++++- src/Model/EmailAddress.php | 249 +++++++++- src/Model/EmailSettings.php | 121 ++++- src/Model/Envelope.php | 327 ++++++++++++- src/Model/EnvelopeAttachment.php | 135 +++++- src/Model/EnvelopeAttachmentsRequest.php | 113 ++++- src/Model/EnvelopeAttachmentsResult.php | 113 ++++- src/Model/EnvelopeAuditEvent.php | 113 ++++- src/Model/EnvelopeAuditEventResponse.php | 113 ++++- src/Model/EnvelopeDefinition.php | 365 +++++++++++++- src/Model/EnvelopeDocument.php | 175 ++++++- src/Model/EnvelopeDocumentsResult.php | 117 ++++- src/Model/EnvelopeEvent.php | 117 ++++- src/Model/EnvelopeFormData.php | 133 ++++- src/Model/EnvelopeId.php | 245 +++++++++- src/Model/EnvelopeIdsRequest.php | 117 ++++- src/Model/EnvelopeNotificationRequest.php | 125 ++++- src/Model/EnvelopeSummary.php | 125 ++++- src/Model/EnvelopeTemplate.php | 337 ++++++++++++- src/Model/EnvelopeTemplateDefinition.php | 177 ++++++- src/Model/EnvelopeTemplateResult.php | 389 ++++++++++++++- src/Model/EnvelopeTemplateResults.php | 141 +++++- src/Model/EnvelopeTransactionStatus.php | 127 ++++- src/Model/EnvelopeUpdateSummary.php | 149 +++++- src/Model/EnvelopesInformation.php | 149 +++++- src/Model/ErrorDetails.php | 117 ++++- src/Model/EventNotification.php | 173 ++++++- src/Model/EventResult.php | 125 ++++- src/Model/Expirations.php | 121 ++++- src/Model/ExternalDocServiceErrorDetails.php | 121 ++++- src/Model/ExternalFile.php | 141 +++++- src/Model/ExternalFolder.php | 151 +++++- src/Model/FeatureSet.php | 145 +++++- src/Model/FileType.php | 117 ++++- src/Model/FileTypeList.php | 113 ++++- src/Model/Filter.php | 153 +++++- src/Model/FirstName.php | 249 +++++++++- src/Model/Folder.php | 161 +++++- src/Model/FolderItem.php | 193 +++++++- src/Model/FolderItemResponse.php | 137 +++++- src/Model/FolderItemV2.php | 191 +++++++- src/Model/FolderItemsResponse.php | 137 +++++- src/Model/FoldersRequest.php | 117 ++++- src/Model/FoldersResponse.php | 113 ++++- src/Model/ForgottenPasswordInformation.php | 141 +++++- src/Model/FormulaTab.php | 323 +++++++++++- src/Model/FullName.php | 249 +++++++++- src/Model/Group.php | 135 +++++- src/Model/GroupInformation.php | 137 +++++- src/Model/IdCheckInformationInput.php | 133 ++++- src/Model/InPersonSigner.php | 397 +++++++++++++-- src/Model/InitialHere.php | 229 ++++++++- src/Model/InlineTemplate.php | 135 +++++- src/Model/IntegratedUserInfoList.php | 141 +++++- src/Model/Intermediary.php | 333 +++++++++++-- src/Model/Jurisdiction.php | 149 +++++- src/Model/LastName.php | 249 +++++++++- src/Model/ListCustomField.php | 143 +++++- src/Model/ListItem.php | 121 ++++- src/Model/LockInformation.php | 145 +++++- src/Model/LockRequest.php | 129 ++++- src/Model/LoginAccount.php | 153 +++++- src/Model/LoginInformation.php | 117 ++++- src/Model/MatchBox.php | 129 ++++- src/Model/MemberGroupSharedItem.php | 125 ++++- src/Model/MemberSharedItems.php | 129 ++++- src/Model/MergeField.php | 129 ++++- src/Model/MobileNotifierConfiguration.php | 123 ++++- ...MobileNotifierConfigurationInformation.php | 113 ++++- src/Model/ModelInterface.php | 96 ++++ src/Model/ModelList.php | 277 ++++++++++- src/Model/Money.php | 121 ++++- src/Model/NameValue.php | 127 ++++- src/Model/NewAccountDefinition.php | 171 +++++-- src/Model/NewAccountSummary.php | 139 +++++- src/Model/NewUser.php | 151 +++++- src/Model/NewUsersDefinition.php | 113 ++++- src/Model/NewUsersSummary.php | 113 ++++- src/Model/Notarize.php | 221 ++++++++- src/Model/NotaryHost.php | 311 ++++++++++-- src/Model/NotaryJournal.php | 137 +++++- src/Model/NotaryJournalCredibleWitness.php | 121 ++++- src/Model/NotaryJournalList.php | 137 +++++- src/Model/NotaryJournalMetaData.php | 125 ++++- src/Model/Note.php | 261 +++++++++- src/Model/Notification.php | 125 ++++- src/Model/Number.php | 309 +++++++++++- src/Model/OauthAccess.php | 133 ++++- src/Model/OfflineAttributes.php | 133 ++++- src/Model/Page.php | 143 +++++- src/Model/PageImages.php | 137 +++++- src/Model/PageRequest.php | 117 ++++- src/Model/PaymentDetails.php | 167 ++++++- src/Model/PaymentGatewayAccount.php | 125 ++++- src/Model/PaymentGatewayAccountsInfo.php | 113 ++++- src/Model/PaymentLineItem.php | 125 ++++- src/Model/PaymentProcessorInformation.php | 123 ++++- src/Model/PermissionProfile.php | 139 +++++- src/Model/PermissionProfileInformation.php | 113 ++++- src/Model/PlanInformation.php | 133 ++++- src/Model/PowerForm.php | 211 +++++++- src/Model/PowerFormFormDataEnvelope.php | 117 ++++- src/Model/PowerFormFormDataRecipient.php | 125 ++++- src/Model/PowerFormRecipient.php | 161 +++++- src/Model/PowerFormSendersResponse.php | 137 +++++- src/Model/PowerFormsFormDataResponse.php | 113 ++++- src/Model/PowerFormsRequest.php | 113 ++++- src/Model/PowerFormsResponse.php | 137 +++++- src/Model/PropertyMetadata.php | 117 ++++- src/Model/Province.php | 117 ++++- src/Model/ProvisioningInformation.php | 137 +++++- src/Model/PurchasedEnvelopesInformation.php | 145 +++++- src/Model/Radio.php | 183 ++++++- src/Model/RadioGroup.php | 157 +++++- src/Model/RecipientAttachment.php | 133 ++++- src/Model/RecipientDomain.php | 125 ++++- src/Model/RecipientEmailNotification.php | 121 ++++- src/Model/RecipientEvent.php | 117 ++++- src/Model/RecipientFormData.php | 141 +++++- src/Model/RecipientIdentityInputOption.php | 121 ++++- src/Model/RecipientIdentityPhoneNumber.php | 121 ++++- src/Model/RecipientIdentityVerification.php | 117 ++++- src/Model/RecipientNamesResponse.php | 121 ++++- src/Model/RecipientPhoneAuthentication.php | 125 ++++- src/Model/RecipientProofFile.php | 113 ++++- src/Model/RecipientSAMLAuthentication.php | 113 ++++- src/Model/RecipientSMSAuthentication.php | 113 ++++- src/Model/RecipientSignatureInformation.php | 121 ++++- src/Model/RecipientSignatureProvider.php | 127 ++++- .../RecipientSignatureProviderOptions.php | 125 ++++- src/Model/RecipientUpdateResponse.php | 125 ++++- src/Model/RecipientViewRequest.php | 225 ++++++++- src/Model/Recipients.php | 159 +++++- src/Model/RecipientsUpdateSummary.php | 113 ++++- src/Model/ReferralInformation.php | 181 ++++++- src/Model/Reminders.php | 121 ++++- src/Model/ResourceInformation.php | 113 ++++- src/Model/ReturnUrlRequest.php | 113 ++++- src/Model/SamlAssertionAttribute.php | 127 ++++- src/Model/SealIdentifier.php | 117 ++++- src/Model/SealSign.php | 307 ++++++++++-- src/Model/SeatDiscount.php | 121 ++++- src/Model/SenderEmailNotifications.php | 145 +++++- src/Model/ServerTemplate.php | 117 ++++- src/Model/ServiceInformation.php | 133 ++++- src/Model/ServiceVersion.php | 117 ++++- src/Model/SettingsMetadata.php | 133 ++++- src/Model/SharedItem.php | 125 ++++- src/Model/SignHere.php | 239 ++++++++- src/Model/SignatureProviderRequiredOption.php | 117 ++++- src/Model/SignatureType.php | 117 ++++- src/Model/Signer.php | 385 +++++++++++++-- src/Model/SignerAttachment.php | 229 ++++++++- src/Model/SignerEmailNotifications.php | 173 ++++++- src/Model/SigningGroup.php | 151 +++++- src/Model/SigningGroupInformation.php | 113 ++++- src/Model/SigningGroupUser.php | 123 ++++- src/Model/SigningGroupUsers.php | 113 ++++- src/Model/SmartSection.php | 251 +++++++++- src/Model/SmartSectionAnchorPosition.php | 121 ++++- ...SmartSectionCollapsibleDisplaySettings.php | 149 +++++- src/Model/SmartSectionDisplaySettings.php | 159 +++++- src/Model/SocialAccountInformation.php | 131 ++++- src/Model/SocialAuthentication.php | 113 ++++- src/Model/Ssn.php | 301 +++++++++++- src/Model/Ssn4InformationInput.php | 121 ++++- src/Model/Ssn9InformationInput.php | 117 ++++- src/Model/SupportedLanguages.php | 113 ++++- src/Model/TabAccountSettings.php | 299 ++++++++++-- src/Model/TabMetadata.php | 323 +++++++++++- src/Model/TabMetadataList.php | 113 ++++- src/Model/Tabs.php | 217 ++++++++- src/Model/TemplateCustomFields.php | 117 ++++- src/Model/TemplateDocumentVisibilityList.php | 113 ++++- src/Model/TemplateDocumentsResult.php | 117 ++++- src/Model/TemplateInformation.php | 113 ++++- src/Model/TemplateMatch.php | 121 ++++- src/Model/TemplateNotificationRequest.php | 129 ++++- src/Model/TemplateRecipients.php | 159 +++++- src/Model/TemplateRole.php | 165 ++++++- src/Model/TemplateSharedItem.php | 141 +++++- src/Model/TemplateSummary.php | 139 +++++- src/Model/TemplateTabs.php | 217 ++++++++- src/Model/TemplateUpdateSummary.php | 149 +++++- src/Model/Text.php | 313 +++++++++++- src/Model/TextCustomField.php | 139 +++++- src/Model/Title.php | 277 ++++++++++- src/Model/UsageHistory.php | 125 ++++- ...erAccountManagementGranularInformation.php | 257 ++++++++-- src/Model/UserInfo.php | 151 +++++- src/Model/UserInfoList.php | 113 ++++- src/Model/UserInformation.php | 271 ++++++++++- src/Model/UserInformationList.php | 137 +++++- src/Model/UserPasswordInformation.php | 127 ++++- src/Model/UserPasswordRules.php | 119 ++++- src/Model/UserProfile.php | 163 ++++++- src/Model/UserSettingsInformation.php | 131 ++++- src/Model/UserSharedItem.php | 125 ++++- src/Model/UserSignature.php | 197 +++++++- src/Model/UserSignatureDefinition.php | 125 ++++- src/Model/UserSignaturesInformation.php | 113 ++++- src/Model/UserSocialIdResult.php | 117 ++++- src/Model/UsersResponse.php | 137 +++++- src/Model/View.php | 261 +++++++++- src/Model/ViewUrl.php | 113 ++++- src/Model/Watermark.php | 145 +++++- src/Model/Witness.php | 393 +++++++++++++-- src/Model/Workspace.php | 157 +++++- src/Model/WorkspaceFolderContents.php | 143 +++++- src/Model/WorkspaceItem.php | 191 +++++++- src/Model/WorkspaceItemList.php | 113 ++++- src/Model/WorkspaceList.php | 129 ++++- src/Model/WorkspaceUser.php | 175 ++++++- src/Model/WorkspaceUserAuthorization.php | 157 +++++- src/Model/Zip.php | 305 +++++++++++- src/ObjectSerializer.php | 73 ++- 370 files changed, 48145 insertions(+), 7434 deletions(-) create mode 100644 src/HeaderSelector.php create mode 100644 src/Model/ModelInterface.php diff --git a/src/Api/AccountsApi.php b/src/Api/AccountsApi.php index e943016d..603bf0a2 100644 --- a/src/Api/AccountsApi.php +++ b/src/Api/AccountsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -962,6 +962,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( @@ -1059,6 +1063,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( @@ -1166,6 +1174,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( @@ -1273,6 +1285,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( @@ -1363,6 +1379,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( @@ -1463,6 +1483,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( @@ -1577,6 +1601,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( @@ -1670,6 +1698,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( @@ -1781,6 +1813,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( @@ -1895,6 +1931,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( @@ -1981,6 +2021,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( @@ -2091,6 +2135,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( @@ -2177,6 +2225,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( @@ -2277,6 +2329,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( @@ -2367,6 +2423,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( @@ -2457,6 +2517,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( @@ -2557,6 +2621,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( @@ -2675,6 +2743,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( @@ -2779,6 +2851,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( @@ -2893,6 +2969,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( @@ -2997,6 +3077,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( @@ -3129,6 +3213,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( @@ -3229,6 +3317,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( @@ -3329,6 +3421,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( @@ -3419,6 +3515,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( @@ -3509,6 +3609,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( @@ -3585,6 +3689,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( @@ -3699,6 +3807,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( @@ -3775,6 +3887,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( @@ -3865,6 +3981,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( @@ -3955,6 +4075,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( @@ -4052,6 +4176,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( @@ -4156,6 +4284,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( @@ -4246,6 +4378,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( @@ -4346,6 +4482,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( @@ -4446,6 +4586,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( @@ -4536,6 +4680,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( @@ -4664,6 +4812,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( @@ -4754,6 +4906,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( @@ -4844,6 +5000,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( @@ -4941,6 +5101,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( @@ -5052,6 +5216,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( @@ -5181,6 +5349,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( @@ -5295,6 +5467,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( @@ -5416,6 +5592,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( @@ -5537,6 +5717,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( @@ -5634,6 +5818,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( @@ -5731,6 +5919,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( @@ -5852,6 +6044,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( @@ -5949,6 +6145,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( @@ -6056,6 +6256,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( @@ -6153,6 +6357,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 f0879df4..cacd1b17 100644 --- a/src/Api/AuthenticationApi.php +++ b/src/Api/AuthenticationApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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 4ad06017..9e65fdb6 100644 --- a/src/Api/BillingApi.php +++ b/src/Api/BillingApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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( @@ -558,6 +566,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 +674,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 +786,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 +866,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 +974,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 +1068,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 +1176,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 +1277,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 +1378,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( @@ -1441,6 +1485,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 8ed731d7..81dcf665 100644 --- a/src/Api/BulkEnvelopesApi.php +++ b/src/Api/BulkEnvelopesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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( @@ -497,6 +501,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( @@ -619,6 +627,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( @@ -751,6 +763,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( @@ -787,7 +803,7 @@ public function getRecipientsWithHttpInfo($account_id, $envelope_id, $recipient_ * * @param string $account_id The external account number (int) or account id GUID. * @param string $envelope_id The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec - * @param string $recipient_id The `recipientId` used when the envelope or template was created. + * @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 * @return \DocuSign\eSign\Model\BulkRecipientsSummaryResponse @@ -805,7 +821,7 @@ public function updateRecipients($account_id, $envelope_id, $recipient_id, $bulk * * @param string $account_id The external account number (int) or account id GUID. * @param string $envelope_id The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec - * @param string $recipient_id The `recipientId` used when the envelope or template was created. + * @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 * @return array of \DocuSign\eSign\Model\BulkRecipientsSummaryResponse, HTTP status code, HTTP response headers (array of strings) @@ -880,6 +896,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 c587790c..93f02d5b 100644 --- a/src/Api/CloudStorageApi.php +++ b/src/Api/CloudStorageApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -586,6 +586,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( @@ -697,6 +701,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( @@ -815,6 +823,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( @@ -926,6 +938,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( @@ -1054,6 +1070,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( @@ -1202,6 +1222,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( @@ -1316,6 +1340,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 b718f233..4cfd3042 100644 --- a/src/Api/ConnectApi.php +++ b/src/Api/ConnectApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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 2bf19b02..83a08022 100644 --- a/src/Api/CustomTabsApi.php +++ b/src/Api/CustomTabsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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/DiagnosticsApi.php b/src/Api/DiagnosticsApi.php index 297ac41c..c932affd 100644 --- a/src/Api/DiagnosticsApi.php +++ b/src/Api/DiagnosticsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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/EnvelopesApi.php b/src/Api/EnvelopesApi.php index ddc8c8fe..26595d7d 100644 --- a/src/Api/EnvelopesApi.php +++ b/src/Api/EnvelopesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -2098,6 +2098,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( @@ -2223,6 +2227,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( @@ -2320,6 +2328,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( @@ -2417,6 +2429,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( @@ -2528,6 +2544,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( @@ -2639,6 +2659,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( @@ -2764,6 +2788,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( @@ -2889,6 +2917,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( @@ -3000,6 +3032,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( @@ -3111,6 +3147,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( @@ -3234,6 +3274,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( @@ -3345,6 +3389,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( @@ -3456,6 +3504,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( @@ -3577,6 +3629,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( @@ -3688,6 +3744,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( @@ -3799,6 +3859,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( @@ -3910,6 +3974,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( @@ -4035,6 +4103,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( @@ -4146,6 +4218,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( @@ -4250,6 +4326,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( @@ -4361,6 +4441,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( @@ -4486,6 +4570,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( @@ -4618,6 +4706,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( @@ -4725,6 +4817,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( @@ -4829,6 +4925,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( @@ -4933,6 +5033,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( @@ -5051,6 +5155,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( @@ -5162,6 +5270,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( @@ -5287,6 +5399,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( @@ -5419,6 +5535,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( @@ -5533,6 +5653,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( @@ -5633,6 +5757,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( @@ -5747,6 +5875,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( @@ -5861,6 +5993,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( @@ -6003,6 +6139,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( @@ -6131,6 +6271,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( @@ -6283,6 +6427,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( @@ -6437,6 +6585,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( @@ -6565,6 +6717,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( @@ -6669,6 +6825,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( @@ -6787,6 +6947,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( @@ -6905,6 +7069,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( @@ -7009,6 +7177,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( @@ -7113,6 +7285,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( @@ -7217,6 +7393,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( @@ -7321,6 +7501,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( @@ -7453,6 +7637,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( @@ -7605,6 +7793,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( @@ -7723,6 +7915,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( @@ -7851,6 +8047,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( @@ -7969,6 +8169,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( @@ -8097,6 +8301,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( @@ -8215,6 +8423,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( @@ -8319,6 +8531,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( @@ -8423,6 +8639,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( @@ -8541,6 +8761,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( @@ -8655,6 +8879,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( @@ -8777,6 +9005,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( @@ -8928,6 +9160,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( @@ -9076,6 +9312,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( @@ -9208,6 +9448,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( @@ -9322,6 +9566,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( @@ -9450,6 +9698,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( @@ -9575,6 +9827,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( @@ -9686,6 +9942,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( @@ -9825,6 +10085,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( @@ -9946,6 +10210,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( @@ -10060,6 +10328,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( @@ -10185,6 +10457,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( @@ -10296,6 +10572,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( @@ -10424,6 +10704,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( @@ -10545,6 +10829,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( @@ -10670,6 +10958,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( @@ -10781,6 +11073,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( @@ -10892,6 +11188,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( @@ -11003,6 +11303,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( @@ -11128,6 +11432,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( @@ -11246,6 +11554,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( @@ -11360,6 +11672,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( @@ -11481,6 +11797,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( @@ -11592,6 +11912,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( @@ -11717,6 +12041,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( @@ -11842,6 +12170,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( @@ -11953,6 +12285,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 a3c075cd..885b19bb 100644 --- a/src/Api/FoldersApi.php +++ b/src/Api/FoldersApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -658,6 +658,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( @@ -796,6 +800,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( @@ -907,6 +915,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( @@ -1045,6 +1057,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 a6d0a4b9..213aba3d 100644 --- a/src/Api/GroupsApi.php +++ b/src/Api/GroupsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -315,6 +315,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( @@ -426,6 +430,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( @@ -537,6 +545,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( @@ -634,6 +646,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( @@ -738,6 +754,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( @@ -856,6 +876,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( @@ -968,6 +992,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( @@ -1079,6 +1107,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( @@ -1190,6 +1222,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( @@ -1287,6 +1323,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 17270b80..11222a99 100644 --- a/src/Api/NotaryApi.php +++ b/src/Api/NotaryApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -234,6 +234,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( diff --git a/src/Api/OrganizationsApi.php b/src/Api/OrganizationsApi.php index 65e331d1..529a81d2 100644 --- a/src/Api/OrganizationsApi.php +++ b/src/Api/OrganizationsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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 5b1073b2..f682bf78 100644 --- a/src/Api/PowerFormsApi.php +++ b/src/Api/PowerFormsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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 a40c8f77..55f60603 100644 --- a/src/Api/SigningGroupsApi.php +++ b/src/Api/SigningGroupsApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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 66b69bdf..aff513d6 100644 --- a/src/Api/TemplatesApi.php +++ b/src/Api/TemplatesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -1337,6 +1337,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( @@ -1462,6 +1466,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( @@ -1573,6 +1581,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( @@ -1684,6 +1696,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( @@ -1805,6 +1821,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( @@ -1930,6 +1950,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( @@ -2027,6 +2051,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( @@ -2152,6 +2180,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( @@ -2263,6 +2295,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( @@ -2381,6 +2417,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( @@ -2492,6 +2532,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( @@ -2617,6 +2661,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( @@ -2756,6 +2804,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( @@ -2863,6 +2915,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( @@ -2988,6 +3044,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( @@ -3099,6 +3159,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( @@ -3224,6 +3288,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( @@ -3335,6 +3403,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( @@ -3460,6 +3532,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( @@ -3574,6 +3650,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( @@ -3706,6 +3786,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( @@ -3860,6 +3944,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( @@ -3988,6 +4076,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( @@ -4092,6 +4184,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( @@ -4196,6 +4292,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( @@ -4328,6 +4428,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( @@ -4480,6 +4584,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( @@ -4598,6 +4706,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( @@ -4702,6 +4814,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( @@ -4834,6 +4950,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( @@ -4938,6 +5058,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( @@ -5056,6 +5180,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( @@ -5160,6 +5288,10 @@ public function listDocumentsWithHttpInfo($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( @@ -5282,6 +5414,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( @@ -5414,6 +5550,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( @@ -5578,6 +5718,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( @@ -5717,6 +5861,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( @@ -5824,6 +5972,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( @@ -5949,6 +6101,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( @@ -6060,6 +6216,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( @@ -6199,6 +6359,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( @@ -6324,6 +6488,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( @@ -6449,6 +6617,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( @@ -6574,6 +6746,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( @@ -6685,6 +6861,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( @@ -6796,6 +6976,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( @@ -6917,6 +7101,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( @@ -7042,6 +7230,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( diff --git a/src/Api/UsersApi.php b/src/Api/UsersApi.php index 92b3785f..44c3fe85 100644 --- a/src/Api/UsersApi.php +++ b/src/Api/UsersApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -644,6 +644,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( @@ -741,6 +745,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( @@ -852,6 +860,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( @@ -959,6 +971,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( @@ -1063,6 +1079,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( @@ -1160,6 +1180,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( @@ -1271,6 +1295,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( @@ -1375,6 +1403,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( @@ -1489,6 +1521,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( @@ -1617,6 +1653,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( @@ -1721,6 +1761,10 @@ public function getContactByIdWithHttpInfo($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( @@ -1839,6 +1883,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( @@ -1943,6 +1991,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( @@ -2057,6 +2109,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( @@ -2161,6 +2217,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( @@ -2279,6 +2339,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( @@ -2421,6 +2485,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( @@ -2525,6 +2593,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( @@ -2639,6 +2711,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( @@ -2736,6 +2812,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( @@ -2833,6 +2913,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( @@ -2944,6 +3028,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( @@ -3055,6 +3143,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( @@ -3155,6 +3247,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( @@ -3262,6 +3358,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( @@ -3393,6 +3493,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( @@ -3525,6 +3629,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( @@ -3636,6 +3744,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( @@ -3747,6 +3859,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( @@ -3844,6 +3960,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 bbebc4f6..148f4325 100644 --- a/src/Api/WorkspacesApi.php +++ b/src/Api/WorkspacesApi.php @@ -17,7 +17,7 @@ * OpenAPI spec version: v2 * 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..a3f0b7a7 --- /dev/null +++ b/src/HeaderSelector.php @@ -0,0 +1,109 @@ +<?php +/** + * ApiException + * PHP version 5 + * + * @category Class + * @package DocuSign\eSign + * @author Swagger Codegen team + * @link https://github.com/swagger-api/swagger-codegen + */ + +/** + * DocuSign REST API + * + * The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + * + * OpenAPI spec version: v2 + * Contact: devcenter@docusign.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + * Swagger Codegen version: 2.4.13-SNAPSHOT + */ + +/** + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen + * Do not edit the class manually. + */ + +namespace DocuSign\eSign; + +use \Exception; + +/** + * ApiException Class Doc Comment + * + * @category Class + * @package DocuSign\eSign + * @author Swagger Codegen team + * @link https://github.com/swagger-api/swagger-codegen + */ +class HeaderSelector +{ + + /** + * @param string[] $accept + * @param string[] $contentTypes + * @return array + */ + public function selectHeaders($accept, $contentTypes) + { + $headers = []; + + $accept = $this->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/AccountAddress.php b/src/Model/AccountAddress.php index 37c0cc74..ebaec031 100644 --- a/src/Model/AccountAddress.php +++ b/src/Model/AccountAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c05cc093..49632cef 100644 --- a/src/Model/AccountBillingPlan.php +++ b/src/Model/AccountBillingPlan.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -77,13 +80,58 @@ 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, + '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 = [ @@ -109,9 +157,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'supportPlanFee' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -137,9 +185,9 @@ public static function swaggerTypes() 'support_plan_fee' => 'setSupportPlanFee' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -165,34 +213,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) { @@ -219,30 +296,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -252,7 +331,9 @@ public function getAddOns() /** * Sets add_ons + * * @param \DocuSign\eSign\Model\AddOn[] $add_ons Reserved: + * * @return $this */ public function setAddOns($add_ons) @@ -264,6 +345,7 @@ public function setAddOns($add_ons) /** * Gets can_cancel_renewal + * * @return string */ public function getCanCancelRenewal() @@ -273,7 +355,9 @@ public function getCanCancelRenewal() /** * Sets can_cancel_renewal + * * @param string $can_cancel_renewal Reserved: TBD + * * @return $this */ public function setCanCancelRenewal($can_cancel_renewal) @@ -285,6 +369,7 @@ public function setCanCancelRenewal($can_cancel_renewal) /** * Gets can_upgrade + * * @return string */ public function getCanUpgrade() @@ -294,7 +379,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) @@ -306,6 +393,7 @@ public function setCanUpgrade($can_upgrade) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -315,7 +403,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) @@ -327,6 +417,7 @@ public function setCurrencyCode($currency_code) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -336,7 +427,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) @@ -348,6 +441,7 @@ public function setEnableSupport($enable_support) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -357,7 +451,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -369,6 +465,7 @@ public function setIncludedSeats($included_seats) /** * Gets incremental_seats + * * @return string */ public function getIncrementalSeats() @@ -378,7 +475,9 @@ public function getIncrementalSeats() /** * Sets incremental_seats + * * @param string $incremental_seats Reserved: TBD + * * @return $this */ public function setIncrementalSeats($incremental_seats) @@ -390,6 +489,7 @@ public function setIncrementalSeats($incremental_seats) /** * Gets is_downgrade + * * @return string */ public function getIsDowngrade() @@ -399,7 +499,9 @@ public function getIsDowngrade() /** * Sets is_downgrade + * * @param string $is_downgrade + * * @return $this */ public function setIsDowngrade($is_downgrade) @@ -411,6 +513,7 @@ public function setIsDowngrade($is_downgrade) /** * Gets other_discount_percent + * * @return string */ public function getOtherDiscountPercent() @@ -420,7 +523,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) @@ -432,6 +537,7 @@ public function setOtherDiscountPercent($other_discount_percent) /** * Gets payment_cycle + * * @return string */ public function getPaymentCycle() @@ -441,7 +547,9 @@ public function getPaymentCycle() /** * Sets payment_cycle + * * @param string $payment_cycle + * * @return $this */ public function setPaymentCycle($payment_cycle) @@ -453,6 +561,7 @@ public function setPaymentCycle($payment_cycle) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -462,7 +571,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) @@ -474,6 +585,7 @@ public function setPaymentMethod($payment_method) /** * Gets per_seat_price + * * @return string */ public function getPerSeatPrice() @@ -483,7 +595,9 @@ public function getPerSeatPrice() /** * Sets per_seat_price + * * @param string $per_seat_price + * * @return $this */ public function setPerSeatPrice($per_seat_price) @@ -495,6 +609,7 @@ public function setPerSeatPrice($per_seat_price) /** * Gets plan_classification + * * @return string */ public function getPlanClassification() @@ -504,7 +619,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) @@ -516,6 +633,7 @@ public function setPlanClassification($plan_classification) /** * Gets plan_feature_sets + * * @return \DocuSign\eSign\Model\FeatureSet[] */ public function getPlanFeatureSets() @@ -525,7 +643,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) @@ -537,6 +657,7 @@ public function setPlanFeatureSets($plan_feature_sets) /** * Gets plan_id + * * @return string */ public function getPlanId() @@ -546,7 +667,9 @@ public function getPlanId() /** * Sets plan_id + * * @param string $plan_id + * * @return $this */ public function setPlanId($plan_id) @@ -558,6 +681,7 @@ public function setPlanId($plan_id) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -567,7 +691,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name The name of the Billing Plan. + * * @return $this */ public function setPlanName($plan_name) @@ -579,6 +705,7 @@ public function setPlanName($plan_name) /** * Gets renewal_status + * * @return string */ public function getRenewalStatus() @@ -588,7 +715,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) @@ -600,6 +729,7 @@ public function setRenewalStatus($renewal_status) /** * Gets seat_discounts + * * @return \DocuSign\eSign\Model\SeatDiscount[] */ public function getSeatDiscounts() @@ -609,7 +739,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) @@ -621,6 +753,7 @@ public function setSeatDiscounts($seat_discounts) /** * Gets support_incident_fee + * * @return string */ public function getSupportIncidentFee() @@ -630,7 +763,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) @@ -642,6 +777,7 @@ public function setSupportIncidentFee($support_incident_fee) /** * Gets support_plan_fee + * * @return string */ public function getSupportPlanFee() @@ -651,7 +787,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) @@ -662,7 +800,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) @@ -672,7 +812,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -682,8 +824,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -697,7 +841,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -707,16 +853,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 d8945be5..f3fb7846 100644 --- a/src/Model/AccountBillingPlanResponse.php +++ b/src/Model/AccountBillingPlanResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -64,13 +67,45 @@ 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, + '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 = [ @@ -83,9 +118,9 @@ public static function swaggerTypes() 'successor_plans' => 'successorPlans' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -98,9 +133,9 @@ public static function swaggerTypes() 'successor_plans' => 'setSuccessorPlans' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -113,34 +148,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) { @@ -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 billing_address + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getBillingAddress() @@ -187,7 +253,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) @@ -199,6 +267,7 @@ public function setBillingAddress($billing_address) /** * Gets billing_address_is_credit_card_address + * * @return string */ public function getBillingAddressIsCreditCardAddress() @@ -208,7 +277,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) @@ -220,6 +291,7 @@ public function setBillingAddressIsCreditCardAddress($billing_address_is_credit_ /** * Gets billing_plan + * * @return \DocuSign\eSign\Model\AccountBillingPlan */ public function getBillingPlan() @@ -229,7 +301,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) @@ -241,6 +315,7 @@ public function setBillingPlan($billing_plan) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -250,7 +325,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) @@ -262,6 +339,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -271,7 +349,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) @@ -283,6 +363,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -292,7 +373,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) @@ -304,6 +387,7 @@ public function setReferralInformation($referral_information) /** * Gets successor_plans + * * @return \DocuSign\eSign\Model\BillingPlan[] */ public function getSuccessorPlans() @@ -313,7 +397,9 @@ public function getSuccessorPlans() /** * Sets successor_plans + * * @param \DocuSign\eSign\Model\BillingPlan[] $successor_plans + * * @return $this */ public function setSuccessorPlans($successor_plans) @@ -324,7 +410,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) @@ -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/AccountIdentityVerificationResponse.php b/src/Model/AccountIdentityVerificationResponse.php index acc2e299..71052591 100644 --- a/src/Model/AccountIdentityVerificationResponse.php +++ b/src/Model/AccountIdentityVerificationResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 30c9285f..d725eab3 100644 --- a/src/Model/AccountIdentityVerificationStep.php +++ b/src/Model/AccountIdentityVerificationStep.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 eb8e43ce..d136f18a 100644 --- a/src/Model/AccountIdentityVerificationWorkflow.php +++ b/src/Model/AccountIdentityVerificationWorkflow.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -59,13 +62,41 @@ class AccountIdentityVerificationWorkflow implements ArrayAccess 'workflow_id' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'default_name' => null, + 'steps' => 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 = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'workflow_id' => 'workflowId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'workflow_id' => 'setWorkflowId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,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) { @@ -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 default_name + * * @return string */ public function getDefaultName() @@ -166,7 +228,9 @@ public function getDefaultName() /** * Sets default_name + * * @param string $default_name + * * @return $this */ public function setDefaultName($default_name) @@ -178,6 +242,7 @@ public function setDefaultName($default_name) /** * Gets steps + * * @return \DocuSign\eSign\Model\AccountIdentityVerificationStep[] */ public function getSteps() @@ -187,7 +252,9 @@ public function getSteps() /** * Sets steps + * * @param \DocuSign\eSign\Model\AccountIdentityVerificationStep[] $steps + * * @return $this */ public function setSteps($steps) @@ -199,6 +266,7 @@ public function setSteps($steps) /** * Gets workflow_id + * * @return string */ public function getWorkflowId() @@ -208,7 +276,9 @@ public function getWorkflowId() /** * Sets workflow_id + * * @param string $workflow_id + * * @return $this */ public function setWorkflowId($workflow_id) @@ -219,7 +289,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) @@ -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/AccountInformation.php b/src/Model/AccountInformation.php index 4c585ae4..fa24956b 100644 --- a/src/Model/AccountInformation.php +++ b/src/Model/AccountInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -89,13 +92,70 @@ 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, + '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_cancel_renewal' => 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, + '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, + '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 = [ @@ -133,9 +193,9 @@ public static function swaggerTypes() 'suspension_status' => 'suspensionStatus' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -173,9 +233,9 @@ public static function swaggerTypes() 'suspension_status' => 'setSuspensionStatus' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -213,34 +273,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) { @@ -279,30 +368,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -312,7 +403,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) @@ -324,6 +417,7 @@ public function setAccountIdGuid($account_id_guid) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -333,7 +427,9 @@ public function getAccountName() /** * Sets account_name + * * @param string $account_name The name of the current account. + * * @return $this */ public function setAccountName($account_name) @@ -345,6 +441,7 @@ public function setAccountName($account_name) /** * Gets allow_transaction_rooms + * * @return string */ public function getAllowTransactionRooms() @@ -354,7 +451,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) @@ -366,6 +465,7 @@ public function setAllowTransactionRooms($allow_transaction_rooms) /** * Gets billing_period_days_remaining + * * @return string */ public function getBillingPeriodDaysRemaining() @@ -375,7 +475,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) @@ -387,6 +489,7 @@ public function setBillingPeriodDaysRemaining($billing_period_days_remaining) /** * Gets billing_period_end_date + * * @return string */ public function getBillingPeriodEndDate() @@ -396,7 +499,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) @@ -408,6 +513,7 @@ public function setBillingPeriodEndDate($billing_period_end_date) /** * Gets billing_period_envelopes_allowed + * * @return string */ public function getBillingPeriodEnvelopesAllowed() @@ -417,7 +523,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) @@ -429,6 +537,7 @@ public function setBillingPeriodEnvelopesAllowed($billing_period_envelopes_allow /** * Gets billing_period_envelopes_sent + * * @return string */ public function getBillingPeriodEnvelopesSent() @@ -438,7 +547,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) @@ -450,6 +561,7 @@ public function setBillingPeriodEnvelopesSent($billing_period_envelopes_sent) /** * Gets billing_period_start_date + * * @return string */ public function getBillingPeriodStartDate() @@ -459,7 +571,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) @@ -471,6 +585,7 @@ public function setBillingPeriodStartDate($billing_period_start_date) /** * Gets billing_profile + * * @return string */ public function getBillingProfile() @@ -480,7 +595,9 @@ public function getBillingProfile() /** * Sets billing_profile + * * @param string $billing_profile Reserved: TBD + * * @return $this */ public function setBillingProfile($billing_profile) @@ -492,6 +609,7 @@ public function setBillingProfile($billing_profile) /** * Gets can_cancel_renewal + * * @return string */ public function getCanCancelRenewal() @@ -501,7 +619,9 @@ public function getCanCancelRenewal() /** * Sets can_cancel_renewal + * * @param string $can_cancel_renewal Reserved: TBD + * * @return $this */ public function setCanCancelRenewal($can_cancel_renewal) @@ -513,6 +633,7 @@ public function setCanCancelRenewal($can_cancel_renewal) /** * Gets can_upgrade + * * @return string */ public function getCanUpgrade() @@ -522,7 +643,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) @@ -534,6 +657,7 @@ public function setCanUpgrade($can_upgrade) /** * Gets connect_permission + * * @return string */ public function getConnectPermission() @@ -543,7 +667,9 @@ public function getConnectPermission() /** * Sets connect_permission + * * @param string $connect_permission + * * @return $this */ public function setConnectPermission($connect_permission) @@ -555,6 +681,7 @@ public function setConnectPermission($connect_permission) /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -564,7 +691,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -576,6 +705,7 @@ public function setCreatedDate($created_date) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -585,7 +715,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) @@ -597,6 +729,7 @@ public function setCurrencyCode($currency_code) /** * Gets current_plan_id + * * @return string */ public function getCurrentPlanId() @@ -606,7 +739,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) @@ -618,6 +753,7 @@ public function setCurrentPlanId($current_plan_id) /** * Gets distributor_code + * * @return string */ public function getDistributorCode() @@ -627,7 +763,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) @@ -639,6 +777,7 @@ public function setDistributorCode($distributor_code) /** * Gets docu_sign_landing_url + * * @return string */ public function getDocuSignLandingUrl() @@ -648,7 +787,9 @@ public function getDocuSignLandingUrl() /** * Sets docu_sign_landing_url + * * @param string $docu_sign_landing_url + * * @return $this */ public function setDocuSignLandingUrl($docu_sign_landing_url) @@ -660,6 +801,7 @@ public function setDocuSignLandingUrl($docu_sign_landing_url) /** * Gets envelope_sending_blocked + * * @return string */ public function getEnvelopeSendingBlocked() @@ -669,7 +811,9 @@ public function getEnvelopeSendingBlocked() /** * Sets envelope_sending_blocked + * * @param string $envelope_sending_blocked + * * @return $this */ public function setEnvelopeSendingBlocked($envelope_sending_blocked) @@ -681,6 +825,7 @@ public function setEnvelopeSendingBlocked($envelope_sending_blocked) /** * Gets envelope_unit_price + * * @return string */ public function getEnvelopeUnitPrice() @@ -690,7 +835,9 @@ public function getEnvelopeUnitPrice() /** * Sets envelope_unit_price + * * @param string $envelope_unit_price + * * @return $this */ public function setEnvelopeUnitPrice($envelope_unit_price) @@ -702,6 +849,7 @@ public function setEnvelopeUnitPrice($envelope_unit_price) /** * Gets external_account_id + * * @return string */ public function getExternalAccountId() @@ -711,7 +859,9 @@ public function getExternalAccountId() /** * Sets external_account_id + * * @param string $external_account_id + * * @return $this */ public function setExternalAccountId($external_account_id) @@ -723,6 +873,7 @@ public function setExternalAccountId($external_account_id) /** * Gets forgotten_password_questions_count + * * @return string */ public function getForgottenPasswordQuestionsCount() @@ -732,7 +883,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) @@ -744,6 +897,7 @@ public function setForgottenPasswordQuestionsCount($forgotten_password_questions /** * Gets is_downgrade + * * @return string */ public function getIsDowngrade() @@ -753,7 +907,9 @@ public function getIsDowngrade() /** * Sets is_downgrade + * * @param string $is_downgrade + * * @return $this */ public function setIsDowngrade($is_downgrade) @@ -765,6 +921,7 @@ public function setIsDowngrade($is_downgrade) /** * Gets payment_method + * * @return string */ public function getPaymentMethod() @@ -774,7 +931,9 @@ public function getPaymentMethod() /** * Sets payment_method + * * @param string $payment_method + * * @return $this */ public function setPaymentMethod($payment_method) @@ -786,6 +945,7 @@ public function setPaymentMethod($payment_method) /** * Gets plan_classification + * * @return string */ public function getPlanClassification() @@ -795,7 +955,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) @@ -807,6 +969,7 @@ public function setPlanClassification($plan_classification) /** * Gets plan_end_date + * * @return string */ public function getPlanEndDate() @@ -816,7 +979,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) @@ -828,6 +993,7 @@ public function setPlanEndDate($plan_end_date) /** * Gets plan_name + * * @return string */ public function getPlanName() @@ -837,7 +1003,9 @@ public function getPlanName() /** * Sets plan_name + * * @param string $plan_name The name of the Billing Plan. + * * @return $this */ public function setPlanName($plan_name) @@ -849,6 +1017,7 @@ public function setPlanName($plan_name) /** * Gets plan_start_date + * * @return string */ public function getPlanStartDate() @@ -858,7 +1027,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) @@ -870,6 +1041,7 @@ public function setPlanStartDate($plan_start_date) /** * Gets seats_allowed + * * @return string */ public function getSeatsAllowed() @@ -879,7 +1051,9 @@ public function getSeatsAllowed() /** * Sets seats_allowed + * * @param string $seats_allowed + * * @return $this */ public function setSeatsAllowed($seats_allowed) @@ -891,6 +1065,7 @@ public function setSeatsAllowed($seats_allowed) /** * Gets seats_in_use + * * @return string */ public function getSeatsInUse() @@ -900,7 +1075,9 @@ public function getSeatsInUse() /** * Sets seats_in_use + * * @param string $seats_in_use + * * @return $this */ public function setSeatsInUse($seats_in_use) @@ -912,6 +1089,7 @@ public function setSeatsInUse($seats_in_use) /** * Gets status21_cfr_part11 + * * @return string */ public function getStatus21CfrPart11() @@ -921,7 +1099,9 @@ public function getStatus21CfrPart11() /** * Sets status21_cfr_part11 + * * @param string $status21_cfr_part11 + * * @return $this */ public function setStatus21CfrPart11($status21_cfr_part11) @@ -933,6 +1113,7 @@ public function setStatus21CfrPart11($status21_cfr_part11) /** * Gets suspension_date + * * @return string */ public function getSuspensionDate() @@ -942,7 +1123,9 @@ public function getSuspensionDate() /** * Sets suspension_date + * * @param string $suspension_date + * * @return $this */ public function setSuspensionDate($suspension_date) @@ -954,6 +1137,7 @@ public function setSuspensionDate($suspension_date) /** * Gets suspension_status + * * @return string */ public function getSuspensionStatus() @@ -963,7 +1147,9 @@ public function getSuspensionStatus() /** * Sets suspension_status + * * @param string $suspension_status + * * @return $this */ public function setSuspensionStatus($suspension_status) @@ -974,7 +1160,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) @@ -984,7 +1172,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -994,8 +1184,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1009,7 +1201,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1019,16 +1213,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 253fed6c..e6ffc234 100644 --- a/src/Model/AccountMinimumPasswordLength.php +++ b/src/Model/AccountMinimumPasswordLength.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/AccountPasswordExpirePasswordDays.php b/src/Model/AccountPasswordExpirePasswordDays.php index 6c557a10..cff15332 100644 --- a/src/Model/AccountPasswordExpirePasswordDays.php +++ b/src/Model/AccountPasswordExpirePasswordDays.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d5e17568..026d4b4b 100644 --- a/src/Model/AccountPasswordLockoutDurationMinutes.php +++ b/src/Model/AccountPasswordLockoutDurationMinutes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 635d4aeb..9d099a00 100644 --- a/src/Model/AccountPasswordLockoutDurationType.php +++ b/src/Model/AccountPasswordLockoutDurationType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 cb65bfa9..e1fc4d28 100644 --- a/src/Model/AccountPasswordMinimumPasswordAgeDays.php +++ b/src/Model/AccountPasswordMinimumPasswordAgeDays.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3f492a5c..cf9cabfc 100644 --- a/src/Model/AccountPasswordQuestionsRequired.php +++ b/src/Model/AccountPasswordQuestionsRequired.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 8c6ba48a..4d806f0d 100644 --- a/src/Model/AccountPasswordRules.php +++ b/src/Model/AccountPasswordRules.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c217ef0f..cc209f64 100644 --- a/src/Model/AccountPasswordStrengthType.php +++ b/src/Model/AccountPasswordStrengthType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 83b4b078..c453a37b 100644 --- a/src/Model/AccountPasswordStrengthTypeOption.php +++ b/src/Model/AccountPasswordStrengthTypeOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 13db555f..25f6fa96 100644 --- a/src/Model/AccountRoleSettings.php +++ b/src/Model/AccountRoleSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -126,13 +129,108 @@ 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_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, + '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 = [ @@ -208,9 +306,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'vaultingModeMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -286,9 +384,9 @@ public static function swaggerTypes() 'vaulting_mode_metadata' => 'setVaultingModeMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -364,34 +462,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) { @@ -468,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 allow_account_management + * * @return string */ public function getAllowAccountManagement() @@ -501,7 +630,9 @@ public function getAllowAccountManagement() /** * Sets allow_account_management + * * @param string $allow_account_management + * * @return $this */ public function setAllowAccountManagement($allow_account_management) @@ -513,6 +644,7 @@ public function setAllowAccountManagement($allow_account_management) /** * Gets allow_account_management_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAccountManagementMetadata() @@ -522,7 +654,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) @@ -534,6 +668,7 @@ public function setAllowAccountManagementMetadata($allow_account_management_meta /** * Gets allow_api_access + * * @return string */ public function getAllowApiAccess() @@ -543,7 +678,9 @@ public function getAllowApiAccess() /** * Sets allow_api_access + * * @param string $allow_api_access + * * @return $this */ public function setAllowApiAccess($allow_api_access) @@ -555,6 +692,7 @@ public function setAllowApiAccess($allow_api_access) /** * Gets allow_api_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiAccessMetadata() @@ -564,7 +702,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) @@ -576,6 +716,7 @@ public function setAllowApiAccessMetadata($allow_api_access_metadata) /** * Gets allow_api_access_to_account + * * @return string */ public function getAllowApiAccessToAccount() @@ -585,7 +726,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) @@ -597,6 +740,7 @@ public function setAllowApiAccessToAccount($allow_api_access_to_account) /** * Gets allow_api_access_to_account_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiAccessToAccountMetadata() @@ -606,7 +750,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) @@ -618,6 +764,7 @@ public function setAllowApiAccessToAccountMetadata($allow_api_access_to_account_ /** * Gets allow_api_sending_on_behalf_of_others + * * @return string */ public function getAllowApiSendingOnBehalfOfOthers() @@ -627,7 +774,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) @@ -639,6 +788,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() @@ -648,7 +798,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) @@ -660,6 +812,7 @@ public function setAllowApiSendingOnBehalfOfOthersMetadata($allow_api_sending_on /** * Gets allow_api_sequential_signing + * * @return string */ public function getAllowApiSequentialSigning() @@ -669,7 +822,9 @@ public function getAllowApiSequentialSigning() /** * Sets allow_api_sequential_signing + * * @param string $allow_api_sequential_signing + * * @return $this */ public function setAllowApiSequentialSigning($allow_api_sequential_signing) @@ -681,6 +836,7 @@ public function setAllowApiSequentialSigning($allow_api_sequential_signing) /** * Gets allow_api_sequential_signing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowApiSequentialSigningMetadata() @@ -690,7 +846,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) @@ -702,6 +860,7 @@ public function setAllowApiSequentialSigningMetadata($allow_api_sequential_signi /** * Gets allow_auto_tagging + * * @return string */ public function getAllowAutoTagging() @@ -711,7 +870,9 @@ public function getAllowAutoTagging() /** * Sets allow_auto_tagging + * * @param string $allow_auto_tagging + * * @return $this */ public function setAllowAutoTagging($allow_auto_tagging) @@ -723,6 +884,7 @@ public function setAllowAutoTagging($allow_auto_tagging) /** * Gets allow_auto_tagging_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowAutoTaggingMetadata() @@ -732,7 +894,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) @@ -744,6 +908,7 @@ public function setAllowAutoTaggingMetadata($allow_auto_tagging_metadata) /** * Gets allow_bulk_sending + * * @return string */ public function getAllowBulkSending() @@ -753,7 +918,9 @@ public function getAllowBulkSending() /** * Sets allow_bulk_sending + * * @param string $allow_bulk_sending + * * @return $this */ public function setAllowBulkSending($allow_bulk_sending) @@ -765,6 +932,7 @@ public function setAllowBulkSending($allow_bulk_sending) /** * Gets allow_bulk_sending_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowBulkSendingMetadata() @@ -774,7 +942,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) @@ -786,6 +956,7 @@ public function setAllowBulkSendingMetadata($allow_bulk_sending_metadata) /** * Gets allow_docu_sign_desktop_client + * * @return string */ public function getAllowDocuSignDesktopClient() @@ -795,7 +966,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) @@ -807,6 +980,7 @@ public function setAllowDocuSignDesktopClient($allow_docu_sign_desktop_client) /** * Gets allow_docu_sign_desktop_client_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowDocuSignDesktopClientMetadata() @@ -816,7 +990,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) @@ -828,6 +1004,7 @@ public function setAllowDocuSignDesktopClientMetadata($allow_docu_sign_desktop_c /** * Gets allowed_address_book_access + * * @return string */ public function getAllowedAddressBookAccess() @@ -837,7 +1014,9 @@ public function getAllowedAddressBookAccess() /** * Sets allowed_address_book_access + * * @param string $allowed_address_book_access + * * @return $this */ public function setAllowedAddressBookAccess($allowed_address_book_access) @@ -849,6 +1028,7 @@ public function setAllowedAddressBookAccess($allowed_address_book_access) /** * Gets allowed_address_book_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedAddressBookAccessMetadata() @@ -858,7 +1038,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) @@ -870,6 +1052,7 @@ public function setAllowedAddressBookAccessMetadata($allowed_address_book_access /** * Gets allowed_template_access + * * @return string */ public function getAllowedTemplateAccess() @@ -879,7 +1062,9 @@ public function getAllowedTemplateAccess() /** * Sets allowed_template_access + * * @param string $allowed_template_access + * * @return $this */ public function setAllowedTemplateAccess($allowed_template_access) @@ -891,6 +1076,7 @@ public function setAllowedTemplateAccess($allowed_template_access) /** * Gets allowed_template_access_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedTemplateAccessMetadata() @@ -900,7 +1086,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) @@ -912,6 +1100,7 @@ public function setAllowedTemplateAccessMetadata($allowed_template_access_metada /** * Gets allowed_to_be_envelope_transfer_recipient + * * @return string */ public function getAllowedToBeEnvelopeTransferRecipient() @@ -921,7 +1110,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) @@ -933,6 +1124,7 @@ public function setAllowedToBeEnvelopeTransferRecipient($allowed_to_be_envelope_ /** * Gets allowed_to_be_envelope_transfer_recipient_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowedToBeEnvelopeTransferRecipientMetadata() @@ -942,7 +1134,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) @@ -954,6 +1148,7 @@ public function setAllowedToBeEnvelopeTransferRecipientMetadata($allowed_to_be_e /** * Gets allow_envelope_sending + * * @return string */ public function getAllowEnvelopeSending() @@ -963,7 +1158,9 @@ public function getAllowEnvelopeSending() /** * Sets allow_envelope_sending + * * @param string $allow_envelope_sending + * * @return $this */ public function setAllowEnvelopeSending($allow_envelope_sending) @@ -975,6 +1172,7 @@ public function setAllowEnvelopeSending($allow_envelope_sending) /** * Gets allow_envelope_sending_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowEnvelopeSendingMetadata() @@ -984,7 +1182,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) @@ -996,6 +1196,7 @@ public function setAllowEnvelopeSendingMetadata($allow_envelope_sending_metadata /** * Gets allow_e_seal_recipients + * * @return string */ public function getAllowESealRecipients() @@ -1005,7 +1206,9 @@ public function getAllowESealRecipients() /** * Sets allow_e_seal_recipients + * * @param string $allow_e_seal_recipients + * * @return $this */ public function setAllowESealRecipients($allow_e_seal_recipients) @@ -1017,6 +1220,7 @@ public function setAllowESealRecipients($allow_e_seal_recipients) /** * Gets allow_e_seal_recipients_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowESealRecipientsMetadata() @@ -1026,7 +1230,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) @@ -1038,6 +1244,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() @@ -1047,7 +1254,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) @@ -1059,6 +1268,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() @@ -1068,7 +1278,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) @@ -1080,6 +1292,7 @@ public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata($al /** * Gets allow_senders_to_set_recipient_email_language + * * @return string */ public function getAllowSendersToSetRecipientEmailLanguage() @@ -1089,7 +1302,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) @@ -1101,6 +1316,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() @@ -1110,7 +1326,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) @@ -1122,6 +1340,7 @@ public function setAllowSendersToSetRecipientEmailLanguageMetadata($allow_sender /** * Gets allow_signer_attachments + * * @return string */ public function getAllowSignerAttachments() @@ -1131,7 +1350,9 @@ public function getAllowSignerAttachments() /** * Sets allow_signer_attachments + * * @param string $allow_signer_attachments + * * @return $this */ public function setAllowSignerAttachments($allow_signer_attachments) @@ -1143,6 +1364,7 @@ public function setAllowSignerAttachments($allow_signer_attachments) /** * Gets allow_signer_attachments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSignerAttachmentsMetadata() @@ -1152,7 +1374,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) @@ -1164,6 +1388,7 @@ public function setAllowSignerAttachmentsMetadata($allow_signer_attachments_meta /** * Gets allow_supplemental_documents + * * @return string */ public function getAllowSupplementalDocuments() @@ -1173,7 +1398,9 @@ public function getAllowSupplementalDocuments() /** * Sets allow_supplemental_documents + * * @param string $allow_supplemental_documents + * * @return $this */ public function setAllowSupplementalDocuments($allow_supplemental_documents) @@ -1185,6 +1412,7 @@ public function setAllowSupplementalDocuments($allow_supplemental_documents) /** * Gets allow_supplemental_documents_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowSupplementalDocumentsMetadata() @@ -1194,7 +1422,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) @@ -1206,6 +1436,7 @@ public function setAllowSupplementalDocumentsMetadata($allow_supplemental_docume /** * Gets allow_tagging_in_send_and_correct + * * @return string */ public function getAllowTaggingInSendAndCorrect() @@ -1215,7 +1446,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) @@ -1227,6 +1460,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() @@ -1236,7 +1470,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) @@ -1248,6 +1484,7 @@ public function setAllowTaggingInSendAndCorrectMetadata($allow_tagging_in_send_a /** * Gets allow_vaulting + * * @return string */ public function getAllowVaulting() @@ -1257,7 +1494,9 @@ public function getAllowVaulting() /** * Sets allow_vaulting + * * @param string $allow_vaulting + * * @return $this */ public function setAllowVaulting($allow_vaulting) @@ -1269,6 +1508,7 @@ public function setAllowVaulting($allow_vaulting) /** * Gets allow_vaulting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowVaultingMetadata() @@ -1278,7 +1518,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) @@ -1290,6 +1532,7 @@ public function setAllowVaultingMetadata($allow_vaulting_metadata) /** * Gets allow_wet_signing_override + * * @return string */ public function getAllowWetSigningOverride() @@ -1299,7 +1542,9 @@ public function getAllowWetSigningOverride() /** * Sets allow_wet_signing_override + * * @param string $allow_wet_signing_override + * * @return $this */ public function setAllowWetSigningOverride($allow_wet_signing_override) @@ -1311,6 +1556,7 @@ public function setAllowWetSigningOverride($allow_wet_signing_override) /** * Gets allow_wet_signing_override_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowWetSigningOverrideMetadata() @@ -1320,7 +1566,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) @@ -1332,6 +1580,7 @@ public function setAllowWetSigningOverrideMetadata($allow_wet_signing_override_m /** * Gets can_create_workspaces + * * @return string */ public function getCanCreateWorkspaces() @@ -1341,7 +1590,9 @@ public function getCanCreateWorkspaces() /** * Sets can_create_workspaces + * * @param string $can_create_workspaces + * * @return $this */ public function setCanCreateWorkspaces($can_create_workspaces) @@ -1353,6 +1604,7 @@ public function setCanCreateWorkspaces($can_create_workspaces) /** * Gets can_create_workspaces_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanCreateWorkspacesMetadata() @@ -1362,7 +1614,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) @@ -1374,6 +1628,7 @@ public function setCanCreateWorkspacesMetadata($can_create_workspaces_metadata) /** * Gets disable_document_upload + * * @return string */ public function getDisableDocumentUpload() @@ -1383,7 +1638,9 @@ public function getDisableDocumentUpload() /** * Sets disable_document_upload + * * @param string $disable_document_upload + * * @return $this */ public function setDisableDocumentUpload($disable_document_upload) @@ -1395,6 +1652,7 @@ public function setDisableDocumentUpload($disable_document_upload) /** * Gets disable_document_upload_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableDocumentUploadMetadata() @@ -1404,7 +1662,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) @@ -1416,6 +1676,7 @@ public function setDisableDocumentUploadMetadata($disable_document_upload_metada /** * Gets disable_other_actions + * * @return string */ public function getDisableOtherActions() @@ -1425,7 +1686,9 @@ public function getDisableOtherActions() /** * Sets disable_other_actions + * * @param string $disable_other_actions + * * @return $this */ public function setDisableOtherActions($disable_other_actions) @@ -1437,6 +1700,7 @@ public function setDisableOtherActions($disable_other_actions) /** * Gets disable_other_actions_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDisableOtherActionsMetadata() @@ -1446,7 +1710,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) @@ -1458,6 +1724,7 @@ public function setDisableOtherActionsMetadata($disable_other_actions_metadata) /** * Gets enable_api_request_logging + * * @return string */ public function getEnableApiRequestLogging() @@ -1467,7 +1734,9 @@ public function getEnableApiRequestLogging() /** * Sets enable_api_request_logging + * * @param string $enable_api_request_logging + * * @return $this */ public function setEnableApiRequestLogging($enable_api_request_logging) @@ -1479,6 +1748,7 @@ public function setEnableApiRequestLogging($enable_api_request_logging) /** * Gets enable_api_request_logging_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableApiRequestLoggingMetadata() @@ -1488,7 +1758,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) @@ -1500,6 +1772,7 @@ public function setEnableApiRequestLoggingMetadata($enable_api_request_logging_m /** * Gets enable_recipient_viewing_notifications + * * @return string */ public function getEnableRecipientViewingNotifications() @@ -1509,7 +1782,9 @@ public function getEnableRecipientViewingNotifications() /** * Sets enable_recipient_viewing_notifications + * * @param string $enable_recipient_viewing_notifications + * * @return $this */ public function setEnableRecipientViewingNotifications($enable_recipient_viewing_notifications) @@ -1521,6 +1796,7 @@ public function setEnableRecipientViewingNotifications($enable_recipient_viewing /** * Gets enable_recipient_viewing_notifications_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableRecipientViewingNotificationsMetadata() @@ -1530,7 +1806,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) @@ -1542,6 +1820,7 @@ public function setEnableRecipientViewingNotificationsMetadata($enable_recipient /** * Gets enable_sequential_signing_interface + * * @return string */ public function getEnableSequentialSigningInterface() @@ -1551,7 +1830,9 @@ public function getEnableSequentialSigningInterface() /** * Sets enable_sequential_signing_interface + * * @param string $enable_sequential_signing_interface + * * @return $this */ public function setEnableSequentialSigningInterface($enable_sequential_signing_interface) @@ -1563,6 +1844,7 @@ public function setEnableSequentialSigningInterface($enable_sequential_signing_i /** * Gets enable_sequential_signing_interface_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableSequentialSigningInterfaceMetadata() @@ -1572,7 +1854,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) @@ -1584,6 +1868,7 @@ public function setEnableSequentialSigningInterfaceMetadata($enable_sequential_s /** * Gets enable_transaction_point_integration + * * @return string */ public function getEnableTransactionPointIntegration() @@ -1593,7 +1878,9 @@ public function getEnableTransactionPointIntegration() /** * Sets enable_transaction_point_integration + * * @param string $enable_transaction_point_integration + * * @return $this */ public function setEnableTransactionPointIntegration($enable_transaction_point_integration) @@ -1605,6 +1892,7 @@ public function setEnableTransactionPointIntegration($enable_transaction_point_i /** * Gets enable_transaction_point_integration_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getEnableTransactionPointIntegrationMetadata() @@ -1614,7 +1902,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) @@ -1626,6 +1916,7 @@ public function setEnableTransactionPointIntegrationMetadata($enable_transaction /** * Gets power_form_role + * * @return string */ public function getPowerFormRole() @@ -1635,7 +1926,9 @@ public function getPowerFormRole() /** * Sets power_form_role + * * @param string $power_form_role + * * @return $this */ public function setPowerFormRole($power_form_role) @@ -1647,6 +1940,7 @@ public function setPowerFormRole($power_form_role) /** * Gets power_form_role_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getPowerFormRoleMetadata() @@ -1656,7 +1950,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) @@ -1668,6 +1964,7 @@ public function setPowerFormRoleMetadata($power_form_role_metadata) /** * Gets receive_completed_self_signed_documents_as_email_links + * * @return string */ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinks() @@ -1677,7 +1974,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) @@ -1689,6 +1988,7 @@ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinks($receive_comp /** * Gets receive_completed_self_signed_documents_as_email_links_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata() @@ -1698,7 +1998,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) @@ -1710,6 +2012,7 @@ public function setReceiveCompletedSelfSignedDocumentsAsEmailLinksMetadata($rece /** * Gets supplemental_documents_must_accept + * * @return string */ public function getSupplementalDocumentsMustAccept() @@ -1719,7 +2022,9 @@ public function getSupplementalDocumentsMustAccept() /** * Sets supplemental_documents_must_accept + * * @param string $supplemental_documents_must_accept + * * @return $this */ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_accept) @@ -1731,6 +2036,7 @@ public function setSupplementalDocumentsMustAccept($supplemental_documents_must_ /** * Gets supplemental_documents_must_accept_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustAcceptMetadata() @@ -1740,7 +2046,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) @@ -1752,6 +2060,7 @@ public function setSupplementalDocumentsMustAcceptMetadata($supplemental_documen /** * Gets supplemental_documents_must_read + * * @return string */ public function getSupplementalDocumentsMustRead() @@ -1761,7 +2070,9 @@ public function getSupplementalDocumentsMustRead() /** * Sets supplemental_documents_must_read + * * @param string $supplemental_documents_must_read + * * @return $this */ public function setSupplementalDocumentsMustRead($supplemental_documents_must_read) @@ -1773,6 +2084,7 @@ public function setSupplementalDocumentsMustRead($supplemental_documents_must_re /** * Gets supplemental_documents_must_read_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustReadMetadata() @@ -1782,7 +2094,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) @@ -1794,6 +2108,7 @@ public function setSupplementalDocumentsMustReadMetadata($supplemental_documents /** * Gets supplemental_documents_must_view + * * @return string */ public function getSupplementalDocumentsMustView() @@ -1803,7 +2118,9 @@ public function getSupplementalDocumentsMustView() /** * Sets supplemental_documents_must_view + * * @param string $supplemental_documents_must_view + * * @return $this */ public function setSupplementalDocumentsMustView($supplemental_documents_must_view) @@ -1815,6 +2132,7 @@ public function setSupplementalDocumentsMustView($supplemental_documents_must_vi /** * Gets supplemental_documents_must_view_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSupplementalDocumentsMustViewMetadata() @@ -1824,7 +2142,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) @@ -1836,6 +2156,7 @@ public function setSupplementalDocumentsMustViewMetadata($supplemental_documents /** * Gets use_new_docu_sign_experience_interface + * * @return string */ public function getUseNewDocuSignExperienceInterface() @@ -1845,7 +2166,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) @@ -1857,6 +2180,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() @@ -1866,7 +2190,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) @@ -1878,6 +2204,7 @@ public function setUseNewDocuSignExperienceInterfaceMetadata($use_new_docu_sign_ /** * Gets use_new_sending_interface + * * @return string */ public function getUseNewSendingInterface() @@ -1887,7 +2214,9 @@ public function getUseNewSendingInterface() /** * Sets use_new_sending_interface + * * @param string $use_new_sending_interface + * * @return $this */ public function setUseNewSendingInterface($use_new_sending_interface) @@ -1899,6 +2228,7 @@ public function setUseNewSendingInterface($use_new_sending_interface) /** * Gets use_new_sending_interface_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getUseNewSendingInterfaceMetadata() @@ -1908,7 +2238,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) @@ -1920,6 +2252,7 @@ public function setUseNewSendingInterfaceMetadata($use_new_sending_interface_met /** * Gets vaulting_mode + * * @return string */ public function getVaultingMode() @@ -1929,7 +2262,9 @@ public function getVaultingMode() /** * Sets vaulting_mode + * * @param string $vaulting_mode + * * @return $this */ public function setVaultingMode($vaulting_mode) @@ -1941,6 +2276,7 @@ public function setVaultingMode($vaulting_mode) /** * Gets vaulting_mode_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getVaultingModeMetadata() @@ -1950,7 +2286,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) @@ -1961,7 +2299,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) @@ -1971,7 +2311,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1981,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) @@ -1996,7 +2340,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -2006,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/AccountSeals.php b/src/Model/AccountSeals.php index 319598b9..3f99bc36 100644 --- a/src/Model/AccountSeals.php +++ b/src/Model/AccountSeals.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 266ca350..3a70d882 100644 --- a/src/Model/AccountSettingsInformation.php +++ b/src/Model/AccountSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,83 +41,140 @@ * @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 = [ 'account_settings' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_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 = [ 'account_settings' => 'accountSettings' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'account_settings' => 'setAccountSettings' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'account_settings' => 'getAccountSettings' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 account_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getAccountSettings() @@ -157,7 +217,9 @@ public function getAccountSettings() /** * Sets account_settings + * * @param \DocuSign\eSign\Model\NameValue[] $account_settings The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden. + * * @return $this */ public function setAccountSettings($account_settings) @@ -168,7 +230,9 @@ public function setAccountSettings($account_settings) } /** * 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/AccountSharedAccess.php b/src/Model/AccountSharedAccess.php index e4f531b3..805125ab 100644 --- a/src/Model/AccountSharedAccess.php +++ b/src/Model/AccountSharedAccess.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b017e92b..022be68d 100644 --- a/src/Model/AccountSignatureProvider.php +++ b/src/Model/AccountSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 661f0766..b0fb30ea 100644 --- a/src/Model/AccountSignatureProviderOption.php +++ b/src/Model/AccountSignatureProviderOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ae389385..f3c4ac66 100644 --- a/src/Model/AccountSignatureProviders.php +++ b/src/Model/AccountSignatureProviders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/AddOn.php b/src/Model/AddOn.php index 46b9efa4..4a141037 100644 --- a/src/Model/AddOn.php +++ b/src/Model/AddOn.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 4aee6616..7bdc7ba6 100644 --- a/src/Model/AddressInformation.php +++ b/src/Model/AddressInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 'state' => 'string', 'street1' => 'string', 'street2' => 'string', - 'zip' => 'string' + 'zip' => 'string', + 'zip_plus4' => 'string' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'city' => null, + 'country' => null, + 'fax' => null, + 'phone' => null, + 'state' => null, + 'street1' => null, + 'street2' => null, + 'zip' => 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() 'state' => 'state', 'street1' => 'street1', 'street2' => 'street2', - 'zip' => 'zip' + 'zip' => 'zip', + '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() 'state' => 'setState', 'street1' => 'setStreet1', 'street2' => 'setStreet2', - 'zip' => 'setZip' + 'zip' => 'setZip', + '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() 'state' => 'getState', 'street1' => 'getStreet1', 'street2' => 'getStreet2', - 'zip' => 'getZip' + 'zip' => 'getZip', + '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['street1'] = isset($data['street1']) ? $data['street1'] : null; $this->container['street2'] = isset($data['street2']) ? $data['street2'] : null; $this->container['zip'] = isset($data['zip']) ? $data['zip'] : 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 city + * * @return string */ public function getCity() @@ -192,7 +265,9 @@ public function getCity() /** * Sets city + * * @param string $city The city associated with the address. + * * @return $this */ public function setCity($city) @@ -204,6 +279,7 @@ public function setCity($city) /** * Gets country + * * @return string */ public function getCountry() @@ -213,7 +289,9 @@ public function getCountry() /** * Sets country + * * @param string $country Specifies the country associated with the address. + * * @return $this */ public function setCountry($country) @@ -225,6 +303,7 @@ public function setCountry($country) /** * Gets fax + * * @return string */ public function getFax() @@ -234,7 +313,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) @@ -246,6 +327,7 @@ public function setFax($fax) /** * Gets phone + * * @return string */ public function getPhone() @@ -255,7 +337,9 @@ public function getPhone() /** * Sets phone + * * @param string $phone A phone number associated with the address. + * * @return $this */ public function setPhone($phone) @@ -267,6 +351,7 @@ public function setPhone($phone) /** * Gets state + * * @return string */ public function getState() @@ -276,7 +361,9 @@ public function getState() /** * Sets state + * * @param string $state The state or province associated with the address. + * * @return $this */ public function setState($state) @@ -288,6 +375,7 @@ public function setState($state) /** * Gets street1 + * * @return string */ public function getStreet1() @@ -297,7 +385,9 @@ public function getStreet1() /** * Sets street1 + * * @param string $street1 The first line of the address. + * * @return $this */ public function setStreet1($street1) @@ -309,6 +399,7 @@ public function setStreet1($street1) /** * Gets street2 + * * @return string */ public function getStreet2() @@ -318,7 +409,9 @@ public function getStreet2() /** * Sets street2 + * * @param string $street2 The second line of the address (optional). + * * @return $this */ public function setStreet2($street2) @@ -330,6 +423,7 @@ public function setStreet2($street2) /** * Gets zip + * * @return string */ public function getZip() @@ -339,7 +433,9 @@ public function getZip() /** * Sets zip + * * @param string $zip The zip or postal code associated with the address. + * * @return $this */ public function setZip($zip) @@ -348,9 +444,35 @@ public function setZip($zip) 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 13603d9b..0fa979f5 100644 --- a/src/Model/AddressInformationInput.php +++ b/src/Model/AddressInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/AddressInformationV2.php b/src/Model/AddressInformationV2.php index e086a3a1..db8adf15 100644 --- a/src/Model/AddressInformationV2.php +++ b/src/Model/AddressInformationV2.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * AddressInformationV2 Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class AddressInformationV2 implements ArrayAccess +class AddressInformationV2 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'addressInformation_v2'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -64,13 +67,46 @@ class AddressInformationV2 implements ArrayAccess 'state_or_province' => '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 + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'state_or_province' => 'stateOrProvince' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -100,9 +136,9 @@ public static function swaggerTypes() 'state_or_province' => 'setStateOrProvince' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -116,34 +152,63 @@ public static function swaggerTypes() 'state_or_province' => 'getStateOrProvince' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 address1 + * * @return string */ public function getAddress1() @@ -191,7 +258,9 @@ public function getAddress1() /** * Sets address1 + * * @param string $address1 First Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress1($address1) @@ -203,6 +272,7 @@ public function setAddress1($address1) /** * Gets address2 + * * @return string */ public function getAddress2() @@ -212,7 +282,9 @@ public function getAddress2() /** * Sets address2 + * * @param string $address2 Second Line of the address. Maximum length: 100 characters. + * * @return $this */ public function setAddress2($address2) @@ -224,6 +296,7 @@ public function setAddress2($address2) /** * Gets city + * * @return string */ public function getCity() @@ -233,7 +306,9 @@ public function getCity() /** * Sets city + * * @param string $city + * * @return $this */ public function setCity($city) @@ -245,6 +320,7 @@ public function setCity($city) /** * Gets country + * * @return string */ public function getCountry() @@ -254,7 +330,9 @@ public function getCountry() /** * Sets country + * * @param string $country Specifies the country associated with the address. + * * @return $this */ public function setCountry($country) @@ -266,6 +344,7 @@ public function setCountry($country) /** * Gets fax + * * @return string */ public function getFax() @@ -275,7 +354,9 @@ public function getFax() /** * Sets fax + * * @param string $fax + * * @return $this */ public function setFax($fax) @@ -287,6 +368,7 @@ public function setFax($fax) /** * Gets phone + * * @return string */ public function getPhone() @@ -296,7 +378,9 @@ public function getPhone() /** * Sets phone + * * @param string $phone + * * @return $this */ public function setPhone($phone) @@ -308,6 +392,7 @@ public function setPhone($phone) /** * Gets postal_code + * * @return string */ public function getPostalCode() @@ -317,7 +402,9 @@ public function getPostalCode() /** * Sets postal_code + * * @param string $postal_code + * * @return $this */ public function setPostalCode($postal_code) @@ -329,6 +416,7 @@ public function setPostalCode($postal_code) /** * Gets state_or_province + * * @return string */ public function getStateOrProvince() @@ -338,7 +426,9 @@ public function getStateOrProvince() /** * Sets state_or_province + * * @param string $state_or_province The state or province associated with the address. + * * @return $this */ public function setStateOrProvince($state_or_province) @@ -349,7 +439,9 @@ public function setStateOrProvince($state_or_province) } /** * 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/Agent.php b/src/Model/Agent.php index 6441aa26..5e35fd11 100644 --- a/src/Model/Agent.php +++ b/src/Model/Agent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +41,20 @@ * @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 = [ @@ -75,6 +78,7 @@ class Agent implements ArrayAccess 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'name' => 'string', @@ -102,13 +106,84 @@ 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, + 'add_access_code_to_email' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -132,6 +207,7 @@ public static function swaggerTypes() 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'name' => 'name', @@ -159,9 +235,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -185,6 +261,7 @@ public static function swaggerTypes() 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'name' => 'setName', @@ -212,9 +289,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -238,6 +315,7 @@ public static function swaggerTypes() 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'name' => 'getName', @@ -265,34 +343,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) { @@ -316,6 +423,7 @@ public function __construct(array $data = null) $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : null; @@ -344,30 +452,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -377,7 +487,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) @@ -389,6 +501,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -398,7 +511,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) @@ -410,6 +525,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -419,7 +535,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) @@ -431,6 +549,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -440,7 +559,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) @@ -452,6 +573,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -461,7 +583,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) @@ -473,6 +597,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -482,7 +607,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) @@ -494,6 +621,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -503,7 +631,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) @@ -515,6 +645,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -524,7 +655,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -536,6 +669,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -545,7 +679,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -557,6 +693,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -566,7 +703,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) @@ -578,6 +717,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -587,7 +727,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) @@ -599,6 +741,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -608,7 +751,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -620,6 +765,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -629,7 +775,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) @@ -641,6 +789,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -650,7 +799,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) @@ -662,6 +813,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -671,7 +823,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) @@ -683,6 +837,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -692,7 +847,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -704,6 +861,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -713,7 +871,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) @@ -725,6 +885,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -734,7 +895,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -746,6 +909,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -755,7 +919,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) @@ -767,6 +933,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -776,7 +943,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) @@ -786,8 +955,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() @@ -797,7 +991,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) @@ -809,6 +1005,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -818,7 +1015,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -830,6 +1029,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -839,7 +1039,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -851,6 +1053,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -860,7 +1063,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) @@ -872,6 +1077,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -881,7 +1087,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) @@ -893,6 +1101,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -902,7 +1111,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -914,6 +1125,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -923,7 +1135,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) @@ -935,6 +1149,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -944,7 +1159,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) @@ -956,6 +1173,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -965,7 +1183,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -977,6 +1197,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -986,7 +1207,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) @@ -998,6 +1221,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1007,7 +1231,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1019,6 +1245,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1028,7 +1255,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) @@ -1040,6 +1269,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1049,7 +1279,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1061,6 +1293,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1070,7 +1303,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) @@ -1082,6 +1317,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1091,7 +1327,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) @@ -1103,6 +1341,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1112,7 +1351,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) @@ -1124,6 +1365,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1133,7 +1375,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) @@ -1145,6 +1389,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1154,7 +1399,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) @@ -1166,6 +1413,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1175,7 +1423,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) @@ -1187,6 +1437,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1196,7 +1447,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) @@ -1208,6 +1461,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1217,7 +1471,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) @@ -1229,6 +1485,7 @@ public function setStatus($status) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1238,7 +1495,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) @@ -1250,6 +1509,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1259,7 +1519,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) @@ -1271,6 +1533,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1280,7 +1543,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1292,6 +1557,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1301,7 +1567,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1312,7 +1580,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) @@ -1322,7 +1592,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1332,8 +1604,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1347,7 +1621,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1357,16 +1633,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 a97aacda..a8eb6fd5 100644 --- a/src/Model/ApiRequestLog.php +++ b/src/Model/ApiRequestLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 2cf02b90..8b55a5ee 100644 --- a/src/Model/ApiRequestLogsResult.php +++ b/src/Model/ApiRequestLogsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 12949969..5a0a2a84 100644 --- a/src/Model/AppStoreProduct.php +++ b/src/Model/AppStoreProduct.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a1f4f4fa..40bc88b9 100644 --- a/src/Model/AppStoreReceipt.php +++ b/src/Model/AppStoreReceipt.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 4660445b..f918c972 100644 --- a/src/Model/Approve.php +++ b/src/Model/Approve.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -91,13 +94,73 @@ class Approve implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'button_text' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'height' => 'int32', + 'italic' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'width' => 'int32', + '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 = [ @@ -138,9 +201,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -181,9 +244,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -224,34 +287,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) { @@ -293,30 +385,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -326,7 +420,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) @@ -338,6 +434,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -347,7 +444,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) @@ -359,6 +458,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -368,7 +468,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) @@ -380,6 +482,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -389,7 +492,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) @@ -401,6 +506,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -410,7 +516,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) @@ -422,6 +530,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -431,7 +540,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) @@ -443,6 +554,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -452,7 +564,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) @@ -464,6 +578,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -473,7 +588,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) @@ -485,6 +602,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -494,7 +612,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) @@ -506,6 +626,7 @@ public function setBold($bold) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -515,7 +636,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) @@ -527,6 +650,7 @@ public function setButtonText($button_text) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -536,7 +660,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) @@ -548,6 +674,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -557,7 +684,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) @@ -569,6 +698,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -578,7 +708,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) @@ -590,6 +722,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -599,7 +732,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) @@ -611,6 +746,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -620,7 +756,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) @@ -632,6 +770,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -641,7 +780,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) @@ -653,6 +794,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -662,7 +804,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) @@ -674,6 +818,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -683,7 +828,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) @@ -695,6 +842,7 @@ public function setFontSize($font_size) /** * Gets height + * * @return int */ public function getHeight() @@ -704,7 +852,9 @@ public function getHeight() /** * Sets height + * * @param int $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -716,6 +866,7 @@ public function setHeight($height) /** * Gets italic + * * @return string */ public function getItalic() @@ -725,7 +876,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) @@ -737,6 +890,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -746,7 +900,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) @@ -758,6 +914,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -767,7 +924,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) @@ -779,6 +938,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -788,7 +948,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) @@ -800,6 +962,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -809,7 +972,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) @@ -821,6 +986,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -830,7 +996,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -842,6 +1010,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -851,7 +1020,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) @@ -863,6 +1034,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -872,7 +1044,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) @@ -884,6 +1058,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -893,7 +1068,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -905,6 +1082,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -914,7 +1092,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) @@ -926,6 +1106,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -935,7 +1116,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) @@ -947,6 +1130,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -956,7 +1140,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -968,6 +1154,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -977,7 +1164,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) @@ -989,6 +1178,7 @@ public function setUnderline($underline) /** * Gets width + * * @return int */ public function getWidth() @@ -998,7 +1188,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1010,6 +1202,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1019,7 +1212,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) @@ -1031,6 +1226,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1040,7 +1236,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) @@ -1051,7 +1249,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) @@ -1061,7 +1261,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1071,8 +1273,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1086,7 +1290,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1096,16 +1302,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 9281fb54..2f49c767 100644 --- a/src/Model/Attachment.php +++ b/src/Model/Attachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5fec71bf..b91bff61 100644 --- a/src/Model/AuthenticationMethod.php +++ b/src/Model/AuthenticationMethod.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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' => 'int' ]; + /** + * 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' => '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 = [ @@ -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 int */ public function getTotalCount() @@ -235,7 +307,9 @@ public function getTotalCount() /** * Sets total_count + * * @param int $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 4dadbdbb..d4cc37bb 100644 --- a/src/Model/AuthenticationStatus.php +++ b/src/Model/AuthenticationStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b81b770e..1e0ddbec 100644 --- a/src/Model/BccEmailAddress.php +++ b/src/Model/BccEmailAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/BillingCharge.php b/src/Model/BillingCharge.php index 80a905a2..4b534032 100644 --- a/src/Model/BillingCharge.php +++ b/src/Model/BillingCharge.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 dde1aa35..21bc3e28 100644 --- a/src/Model/BillingChargeResponse.php +++ b/src/Model/BillingChargeResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 03ad4986..d22a6132 100644 --- a/src/Model/BillingDiscount.php +++ b/src/Model/BillingDiscount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 135f3443..266e1305 100644 --- a/src/Model/BillingInvoice.php +++ b/src/Model/BillingInvoice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 73df52b6..3c4642c4 100644 --- a/src/Model/BillingInvoiceItem.php +++ b/src/Model/BillingInvoiceItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d50ba8ba..561f5c7f 100644 --- a/src/Model/BillingInvoicesResponse.php +++ b/src/Model/BillingInvoicesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c44a6e00..cc6d13fd 100644 --- a/src/Model/BillingInvoicesSummary.php +++ b/src/Model/BillingInvoicesSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 64d16666..50279875 100644 --- a/src/Model/BillingPayment.php +++ b/src/Model/BillingPayment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 f6893c61..1946b62d 100644 --- a/src/Model/BillingPaymentItem.php +++ b/src/Model/BillingPaymentItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 420cde10..6989a9d9 100644 --- a/src/Model/BillingPaymentRequest.php +++ b/src/Model/BillingPaymentRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c6c1496a..ed717eb0 100644 --- a/src/Model/BillingPaymentResponse.php +++ b/src/Model/BillingPaymentResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 aead2eca..47a14e17 100644 --- a/src/Model/BillingPaymentsResponse.php +++ b/src/Model/BillingPaymentsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 87210297..a51a707d 100644 --- a/src/Model/BillingPlan.php +++ b/src/Model/BillingPlan.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d4081dca..721709ee 100644 --- a/src/Model/BillingPlanInformation.php +++ b/src/Model/BillingPlanInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -72,13 +75,54 @@ 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, + 'downgrade_reason' => null, + 'enable_support' => null, + 'included_seats' => null, + 'incremental_seats' => 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 = [ @@ -100,9 +144,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 = [ @@ -124,9 +168,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 = [ @@ -148,34 +192,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) { @@ -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 app_store_receipt + * * @return \DocuSign\eSign\Model\AppStoreReceipt */ public function getAppStoreReceipt() @@ -231,7 +306,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) @@ -243,6 +320,7 @@ public function setAppStoreReceipt($app_store_receipt) /** * Gets billing_address + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getBillingAddress() @@ -252,7 +330,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) @@ -264,6 +344,7 @@ public function setBillingAddress($billing_address) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -273,7 +354,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) @@ -285,6 +368,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets downgrade_reason + * * @return string */ public function getDowngradeReason() @@ -294,7 +378,9 @@ public function getDowngradeReason() /** * Sets downgrade_reason + * * @param string $downgrade_reason + * * @return $this */ public function setDowngradeReason($downgrade_reason) @@ -306,6 +392,7 @@ public function setDowngradeReason($downgrade_reason) /** * Gets enable_support + * * @return string */ public function getEnableSupport() @@ -315,7 +402,9 @@ public function getEnableSupport() /** * Sets enable_support + * * @param string $enable_support + * * @return $this */ public function setEnableSupport($enable_support) @@ -327,6 +416,7 @@ public function setEnableSupport($enable_support) /** * Gets included_seats + * * @return string */ public function getIncludedSeats() @@ -336,7 +426,9 @@ public function getIncludedSeats() /** * Sets included_seats + * * @param string $included_seats The number of seats (users) included. + * * @return $this */ public function setIncludedSeats($included_seats) @@ -348,6 +440,7 @@ public function setIncludedSeats($included_seats) /** * Gets incremental_seats + * * @return string */ public function getIncrementalSeats() @@ -357,7 +450,9 @@ public function getIncrementalSeats() /** * Sets incremental_seats + * * @param string $incremental_seats Reserved: TBD + * * @return $this */ public function setIncrementalSeats($incremental_seats) @@ -369,6 +464,7 @@ public function setIncrementalSeats($incremental_seats) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -378,7 +474,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) @@ -390,6 +488,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets plan_information + * * @return \DocuSign\eSign\Model\PlanInformation */ public function getPlanInformation() @@ -399,7 +498,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) @@ -411,6 +512,7 @@ public function setPlanInformation($plan_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -420,7 +522,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) @@ -432,6 +536,7 @@ public function setReferralInformation($referral_information) /** * Gets renewal_status + * * @return string */ public function getRenewalStatus() @@ -441,7 +546,9 @@ public function getRenewalStatus() /** * Sets renewal_status + * * @param string $renewal_status + * * @return $this */ public function setRenewalStatus($renewal_status) @@ -453,6 +560,7 @@ public function setRenewalStatus($renewal_status) /** * Gets sale_discount_amount + * * @return string */ public function getSaleDiscountAmount() @@ -462,7 +570,9 @@ public function getSaleDiscountAmount() /** * Sets sale_discount_amount + * * @param string $sale_discount_amount + * * @return $this */ public function setSaleDiscountAmount($sale_discount_amount) @@ -474,6 +584,7 @@ public function setSaleDiscountAmount($sale_discount_amount) /** * Gets sale_discount_fixed_amount + * * @return string */ public function getSaleDiscountFixedAmount() @@ -483,7 +594,9 @@ public function getSaleDiscountFixedAmount() /** * Sets sale_discount_fixed_amount + * * @param string $sale_discount_fixed_amount + * * @return $this */ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) @@ -495,6 +608,7 @@ public function setSaleDiscountFixedAmount($sale_discount_fixed_amount) /** * Gets sale_discount_percent + * * @return string */ public function getSaleDiscountPercent() @@ -504,7 +618,9 @@ public function getSaleDiscountPercent() /** * Sets sale_discount_percent + * * @param string $sale_discount_percent + * * @return $this */ public function setSaleDiscountPercent($sale_discount_percent) @@ -516,6 +632,7 @@ public function setSaleDiscountPercent($sale_discount_percent) /** * Gets sale_discount_periods + * * @return string */ public function getSaleDiscountPeriods() @@ -525,7 +642,9 @@ public function getSaleDiscountPeriods() /** * Sets sale_discount_periods + * * @param string $sale_discount_periods + * * @return $this */ public function setSaleDiscountPeriods($sale_discount_periods) @@ -537,6 +656,7 @@ public function setSaleDiscountPeriods($sale_discount_periods) /** * Gets sale_discount_seat_price_override + * * @return string */ public function getSaleDiscountSeatPriceOverride() @@ -546,7 +666,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) @@ -557,7 +679,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) @@ -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/BillingPlanPreview.php b/src/Model/BillingPlanPreview.php index 0317ee8b..9dbde381 100644 --- a/src/Model/BillingPlanPreview.php +++ b/src/Model/BillingPlanPreview.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 fab2b727..f1d3cf1c 100644 --- a/src/Model/BillingPlanResponse.php +++ b/src/Model/BillingPlanResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 46c4de09..cf6f779c 100644 --- a/src/Model/BillingPlanUpdateResponse.php +++ b/src/Model/BillingPlanUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 067a1d94..048618a0 100644 --- a/src/Model/BillingPlansResponse.php +++ b/src/Model/BillingPlansResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6cce2817..54e5c2c2 100644 --- a/src/Model/BillingPrice.php +++ b/src/Model/BillingPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 26250f9c..19c70935 100644 --- a/src/Model/Brand.php +++ b/src/Model/Brand.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -69,13 +72,51 @@ 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_name' => null, + 'colors' => 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 = [ @@ -94,9 +135,9 @@ public static function swaggerTypes() 'resources' => 'resources' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -115,9 +156,9 @@ public static function swaggerTypes() 'resources' => 'setResources' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -136,34 +177,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) { @@ -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 brand_company + * * @return string */ public function getBrandCompany() @@ -216,7 +288,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) @@ -228,6 +302,7 @@ public function setBrandCompany($brand_company) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -237,7 +312,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) @@ -249,6 +326,7 @@ public function setBrandId($brand_id) /** * Gets brand_name + * * @return string */ public function getBrandName() @@ -258,7 +336,9 @@ public function getBrandName() /** * Sets brand_name + * * @param string $brand_name The name of the brand. + * * @return $this */ public function setBrandName($brand_name) @@ -270,6 +350,7 @@ public function setBrandName($brand_name) /** * Gets colors + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getColors() @@ -279,7 +360,9 @@ public function getColors() /** * Sets colors + * * @param \DocuSign\eSign\Model\NameValue[] $colors + * * @return $this */ public function setColors($colors) @@ -291,6 +374,7 @@ public function setColors($colors) /** * Gets email_content + * * @return \DocuSign\eSign\Model\BrandEmailContent[] */ public function getEmailContent() @@ -300,7 +384,9 @@ public function getEmailContent() /** * Sets email_content + * * @param \DocuSign\eSign\Model\BrandEmailContent[] $email_content + * * @return $this */ public function setEmailContent($email_content) @@ -312,6 +398,7 @@ public function setEmailContent($email_content) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -321,7 +408,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) @@ -333,6 +422,7 @@ public function setErrorDetails($error_details) /** * Gets is_overriding_company_name + * * @return string */ public function getIsOverridingCompanyName() @@ -342,7 +432,9 @@ public function getIsOverridingCompanyName() /** * Sets is_overriding_company_name + * * @param string $is_overriding_company_name + * * @return $this */ public function setIsOverridingCompanyName($is_overriding_company_name) @@ -354,6 +446,7 @@ public function setIsOverridingCompanyName($is_overriding_company_name) /** * Gets is_sending_default + * * @return string */ public function getIsSendingDefault() @@ -363,7 +456,9 @@ public function getIsSendingDefault() /** * Sets is_sending_default + * * @param string $is_sending_default + * * @return $this */ public function setIsSendingDefault($is_sending_default) @@ -375,6 +470,7 @@ public function setIsSendingDefault($is_sending_default) /** * Gets is_signing_default + * * @return string */ public function getIsSigningDefault() @@ -384,7 +480,9 @@ public function getIsSigningDefault() /** * Sets is_signing_default + * * @param string $is_signing_default + * * @return $this */ public function setIsSigningDefault($is_signing_default) @@ -396,6 +494,7 @@ public function setIsSigningDefault($is_signing_default) /** * Gets landing_pages + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getLandingPages() @@ -405,7 +504,9 @@ public function getLandingPages() /** * Sets landing_pages + * * @param \DocuSign\eSign\Model\NameValue[] $landing_pages + * * @return $this */ public function setLandingPages($landing_pages) @@ -417,6 +518,7 @@ public function setLandingPages($landing_pages) /** * Gets links + * * @return \DocuSign\eSign\Model\BrandLink[] */ public function getLinks() @@ -426,7 +528,9 @@ public function getLinks() /** * Sets links + * * @param \DocuSign\eSign\Model\BrandLink[] $links + * * @return $this */ public function setLinks($links) @@ -438,6 +542,7 @@ public function setLinks($links) /** * Gets logos + * * @return \DocuSign\eSign\Model\BrandLogos */ public function getLogos() @@ -447,7 +552,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) @@ -459,6 +566,7 @@ public function setLogos($logos) /** * Gets resources + * * @return \DocuSign\eSign\Model\BrandResourceUrls */ public function getResources() @@ -468,7 +576,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) @@ -479,7 +589,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) @@ -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/BrandEmailContent.php b/src/Model/BrandEmailContent.php index fd69fc7a..0f3119d0 100644 --- a/src/Model/BrandEmailContent.php +++ b/src/Model/BrandEmailContent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ac999e1c..39e5e6d1 100644 --- a/src/Model/BrandLink.php +++ b/src/Model/BrandLink.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 93355ad4..551b1e59 100644 --- a/src/Model/BrandLogos.php +++ b/src/Model/BrandLogos.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 864b718b..ce042a16 100644 --- a/src/Model/BrandRequest.php +++ b/src/Model/BrandRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 79401352..03db37ea 100644 --- a/src/Model/BrandResourceUrls.php +++ b/src/Model/BrandResourceUrls.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9802a56e..66174ad2 100644 --- a/src/Model/BrandResources.php +++ b/src/Model/BrandResources.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -63,13 +66,45 @@ 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, + '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 = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'resources_content_uri' => 'resourcesContentUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'resources_content_uri' => 'setResourcesContentUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,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) { @@ -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 created_by_user_info + * * @return \DocuSign\eSign\Model\UserInfo */ public function getCreatedByUserInfo() @@ -186,7 +252,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) @@ -198,6 +266,7 @@ public function setCreatedByUserInfo($created_by_user_info) /** * Gets created_date + * * @return string */ public function getCreatedDate() @@ -207,7 +276,9 @@ public function getCreatedDate() /** * Sets created_date + * * @param string $created_date + * * @return $this */ public function setCreatedDate($created_date) @@ -219,6 +290,7 @@ public function setCreatedDate($created_date) /** * Gets modified_by_user_info + * * @return \DocuSign\eSign\Model\UserInfo */ public function getModifiedByUserInfo() @@ -228,7 +300,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) @@ -240,6 +314,7 @@ public function setModifiedByUserInfo($modified_by_user_info) /** * Gets modified_date + * * @return string */ public function getModifiedDate() @@ -249,7 +324,9 @@ public function getModifiedDate() /** * Sets modified_date + * * @param string $modified_date + * * @return $this */ public function setModifiedDate($modified_date) @@ -261,6 +338,7 @@ public function setModifiedDate($modified_date) /** * Gets modified_templates + * * @return string[] */ public function getModifiedTemplates() @@ -270,7 +348,9 @@ public function getModifiedTemplates() /** * Sets modified_templates + * * @param string[] $modified_templates + * * @return $this */ public function setModifiedTemplates($modified_templates) @@ -282,6 +362,7 @@ public function setModifiedTemplates($modified_templates) /** * Gets resources_content_type + * * @return string */ public function getResourcesContentType() @@ -291,7 +372,9 @@ public function getResourcesContentType() /** * Sets resources_content_type + * * @param string $resources_content_type + * * @return $this */ public function setResourcesContentType($resources_content_type) @@ -303,6 +386,7 @@ public function setResourcesContentType($resources_content_type) /** * Gets resources_content_uri + * * @return string */ public function getResourcesContentUri() @@ -312,7 +396,9 @@ public function getResourcesContentUri() /** * Sets resources_content_uri + * * @param string $resources_content_uri + * * @return $this */ public function setResourcesContentUri($resources_content_uri) @@ -323,7 +409,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) @@ -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/BrandResourcesList.php b/src/Model/BrandResourcesList.php index fae61d93..fdd38d09 100644 --- a/src/Model/BrandResourcesList.php +++ b/src/Model/BrandResourcesList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 bf6e18cb..8ae535c5 100644 --- a/src/Model/BrandsRequest.php +++ b/src/Model/BrandsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e0bade99..06aad6be 100644 --- a/src/Model/BrandsResponse.php +++ b/src/Model/BrandsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e3730af7..0e3ca94f 100644 --- a/src/Model/BulkEnvelope.php +++ b/src/Model/BulkEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 88f79600..d1c7b1b4 100644 --- a/src/Model/BulkEnvelopeStatus.php +++ b/src/Model/BulkEnvelopeStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 1cf73eec..159cf712 100644 --- a/src/Model/BulkEnvelopesResponse.php +++ b/src/Model/BulkEnvelopesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5ce58ff7..7cd9c7a6 100644 --- a/src/Model/BulkRecipient.php +++ b/src/Model/BulkRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 274068f7..4b633e28 100644 --- a/src/Model/BulkRecipientSignatureProvider.php +++ b/src/Model/BulkRecipientSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 2c25e710..d1aab683 100644 --- a/src/Model/BulkRecipientTabLabel.php +++ b/src/Model/BulkRecipientTabLabel.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d55247f1..e0f37291 100644 --- a/src/Model/BulkRecipientsRequest.php +++ b/src/Model/BulkRecipientsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 179474cb..86e50d0b 100644 --- a/src/Model/BulkRecipientsResponse.php +++ b/src/Model/BulkRecipientsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6710721f..a41492ba 100644 --- a/src/Model/BulkRecipientsSummaryResponse.php +++ b/src/Model/BulkRecipientsSummaryResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6e41fb68..9e7748d7 100644 --- a/src/Model/BulkRecipientsUpdateResponse.php +++ b/src/Model/BulkRecipientsUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/CaptiveRecipient.php b/src/Model/CaptiveRecipient.php index 62ad9fc5..f19c6f14 100644 --- a/src/Model/CaptiveRecipient.php +++ b/src/Model/CaptiveRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5435be37..848cd9a2 100644 --- a/src/Model/CaptiveRecipientInformation.php +++ b/src/Model/CaptiveRecipientInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 fbeca14a..378a11f5 100644 --- a/src/Model/CarbonCopy.php +++ b/src/Model/CarbonCopy.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -105,13 +108,87 @@ 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, + 'add_access_code_to_email' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -166,9 +243,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -223,9 +300,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -280,34 +357,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) { @@ -363,30 +469,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -396,7 +504,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) @@ -408,6 +518,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -417,7 +528,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) @@ -429,6 +542,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -438,7 +552,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -450,6 +566,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -459,7 +576,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -471,6 +590,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -480,7 +600,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) @@ -492,6 +614,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -501,7 +624,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) @@ -513,6 +638,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -522,7 +648,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) @@ -534,6 +662,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -543,7 +672,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) @@ -555,6 +686,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -564,7 +696,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) @@ -576,6 +710,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -585,7 +720,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -597,6 +734,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -606,7 +744,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -618,6 +758,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -627,7 +768,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) @@ -639,6 +782,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -648,7 +792,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) @@ -660,6 +806,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -669,7 +816,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -681,6 +830,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -690,7 +840,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) @@ -702,6 +854,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -711,7 +864,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) @@ -723,6 +878,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -732,7 +888,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) @@ -744,6 +902,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -753,7 +912,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -765,6 +926,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -774,7 +936,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) @@ -786,6 +950,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -795,7 +960,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -807,6 +974,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -816,7 +984,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) @@ -828,6 +998,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -837,7 +1008,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) @@ -849,6 +1022,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -858,7 +1032,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) @@ -870,6 +1046,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -879,7 +1056,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) @@ -891,6 +1070,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -900,7 +1080,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -912,6 +1094,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -921,7 +1104,9 @@ public function getName() /** * Sets name + * * @param string $name legal name of the recipient. Maximum Length: 100 characters. + * * @return $this */ public function setName($name) @@ -933,6 +1118,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -942,7 +1128,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) @@ -954,6 +1142,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -963,7 +1152,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) @@ -975,6 +1166,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -984,7 +1176,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) @@ -996,6 +1190,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1005,7 +1200,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1017,6 +1214,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1026,7 +1224,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) @@ -1038,6 +1238,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1047,7 +1248,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) @@ -1059,6 +1262,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1068,7 +1272,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1080,6 +1286,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1089,7 +1296,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) @@ -1101,6 +1310,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1110,7 +1320,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1122,6 +1334,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1131,7 +1344,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) @@ -1143,6 +1358,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1152,7 +1368,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1164,6 +1382,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1173,7 +1392,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) @@ -1185,6 +1406,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1194,7 +1416,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) @@ -1206,6 +1430,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1215,7 +1440,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) @@ -1227,6 +1454,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1236,7 +1464,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) @@ -1248,6 +1478,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1257,7 +1488,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) @@ -1269,6 +1502,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1278,7 +1512,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) @@ -1290,6 +1526,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1299,7 +1536,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) @@ -1311,6 +1550,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1320,7 +1560,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) @@ -1332,6 +1574,7 @@ public function setStatus($status) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1341,7 +1584,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) @@ -1353,6 +1598,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1362,7 +1608,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) @@ -1374,6 +1622,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1383,7 +1632,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1395,6 +1646,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1404,7 +1656,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1415,7 +1669,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) @@ -1425,7 +1681,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1435,8 +1693,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1450,7 +1710,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1460,16 +1722,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 e3c320f8..9b2fade4 100644 --- a/src/Model/CertifiedDelivery.php +++ b/src/Model/CertifiedDelivery.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -105,13 +108,87 @@ 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, + 'add_access_code_to_email' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -166,9 +243,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -223,9 +300,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -280,34 +357,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) { @@ -363,30 +469,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -396,7 +504,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) @@ -408,6 +518,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -417,7 +528,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) @@ -429,6 +542,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -438,7 +552,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -450,6 +566,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -459,7 +576,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -471,6 +590,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -480,7 +600,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) @@ -492,6 +614,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -501,7 +624,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) @@ -513,6 +638,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -522,7 +648,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) @@ -534,6 +662,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -543,7 +672,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) @@ -555,6 +686,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -564,7 +696,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) @@ -576,6 +710,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -585,7 +720,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -597,6 +734,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -606,7 +744,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -618,6 +758,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -627,7 +768,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -639,6 +782,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -648,7 +792,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) @@ -660,6 +806,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -669,7 +816,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -681,6 +830,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -690,7 +840,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) @@ -702,6 +854,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -711,7 +864,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) @@ -723,6 +878,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -732,7 +888,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) @@ -744,6 +902,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -753,7 +912,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -765,6 +926,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -774,7 +936,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) @@ -786,6 +950,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -795,7 +960,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -807,6 +974,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -816,7 +984,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) @@ -828,6 +998,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -837,7 +1008,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) @@ -849,6 +1022,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -858,7 +1032,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) @@ -870,6 +1046,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -879,7 +1056,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) @@ -891,6 +1070,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -900,7 +1080,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -912,6 +1094,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -921,7 +1104,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -933,6 +1118,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -942,7 +1128,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) @@ -954,6 +1142,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -963,7 +1152,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) @@ -975,6 +1166,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -984,7 +1176,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) @@ -996,6 +1190,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1005,7 +1200,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1017,6 +1214,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1026,7 +1224,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) @@ -1038,6 +1238,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1047,7 +1248,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) @@ -1059,6 +1262,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1068,7 +1272,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1080,6 +1286,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1089,7 +1296,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) @@ -1101,6 +1310,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1110,7 +1320,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1122,6 +1334,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1131,7 +1344,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) @@ -1143,6 +1358,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1152,7 +1368,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1164,6 +1382,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1173,7 +1392,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) @@ -1185,6 +1406,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1194,7 +1416,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) @@ -1206,6 +1430,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1215,7 +1440,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) @@ -1227,6 +1454,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1236,7 +1464,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) @@ -1248,6 +1478,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1257,7 +1488,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) @@ -1269,6 +1502,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1278,7 +1512,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) @@ -1290,6 +1526,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1299,7 +1536,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) @@ -1311,6 +1550,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1320,7 +1560,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) @@ -1332,6 +1574,7 @@ public function setStatus($status) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1341,7 +1584,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) @@ -1353,6 +1598,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1362,7 +1608,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) @@ -1374,6 +1622,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1383,7 +1632,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1395,6 +1646,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1404,7 +1656,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1415,7 +1669,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) @@ -1425,7 +1681,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1435,8 +1693,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1450,7 +1710,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1460,16 +1722,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 86431b9f..abb7c441 100644 --- a/src/Model/Checkbox.php +++ b/src/Model/Checkbox.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -88,13 +91,70 @@ class Checkbox implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'locked' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'selected' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -132,9 +192,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -172,9 +232,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -212,34 +272,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) { @@ -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 anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -311,7 +402,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) @@ -323,6 +416,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -332,7 +426,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) @@ -344,6 +440,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -353,7 +450,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) @@ -365,6 +464,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -374,7 +474,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) @@ -386,6 +488,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -395,7 +498,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) @@ -407,6 +512,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -416,7 +522,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) @@ -428,6 +536,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -437,7 +546,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) @@ -449,6 +560,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -458,7 +570,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) @@ -470,6 +584,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -479,7 +594,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) @@ -491,6 +608,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -500,7 +618,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) @@ -512,6 +632,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -521,7 +642,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) @@ -533,6 +656,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -542,7 +666,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) @@ -554,6 +680,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -563,7 +690,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) @@ -575,6 +704,7 @@ public function setErrorDetails($error_details) /** * Gets locked + * * @return string */ public function getLocked() @@ -584,7 +714,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) @@ -596,6 +728,7 @@ public function setLocked($locked) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -605,7 +738,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) @@ -617,6 +752,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -626,7 +762,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -638,6 +776,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -647,7 +786,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) @@ -659,6 +800,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -668,7 +810,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) @@ -680,6 +824,7 @@ public function setRecipientId($recipient_id) /** * Gets required + * * @return string */ public function getRequired() @@ -689,7 +834,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) @@ -701,6 +848,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -710,7 +858,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) @@ -722,6 +872,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets selected + * * @return string */ public function getSelected() @@ -731,7 +882,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected When set to **true**, the checkbox is selected. + * * @return $this */ public function setSelected($selected) @@ -743,6 +896,7 @@ public function setSelected($selected) /** * Gets shared + * * @return string */ public function getShared() @@ -752,7 +906,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -764,6 +920,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -773,7 +930,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) @@ -785,6 +944,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -794,7 +954,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -806,6 +968,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -815,7 +978,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) @@ -827,6 +992,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -836,7 +1002,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) @@ -848,6 +1016,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -857,7 +1026,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -869,6 +1040,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -878,7 +1050,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) @@ -890,6 +1064,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -899,7 +1074,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) @@ -911,6 +1088,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -920,7 +1098,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -932,6 +1112,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -941,7 +1122,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) @@ -953,6 +1136,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -962,7 +1146,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) @@ -973,7 +1159,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) @@ -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/ChunkedUploadPart.php b/src/Model/ChunkedUploadPart.php index 5d2691d5..39fd26e8 100644 --- a/src/Model/ChunkedUploadPart.php +++ b/src/Model/ChunkedUploadPart.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 594a4cfb..505e5c21 100644 --- a/src/Model/ChunkedUploadRequest.php +++ b/src/Model/ChunkedUploadRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 1832fc24..16abf933 100644 --- a/src/Model/ChunkedUploadResponse.php +++ b/src/Model/ChunkedUploadResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ca32828a..d14340b2 100644 --- a/src/Model/CloudStorageProvider.php +++ b/src/Model/CloudStorageProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ba3627d3..67e886a8 100644 --- a/src/Model/CloudStorageProviders.php +++ b/src/Model/CloudStorageProviders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/Company.php b/src/Model/Company.php index efeeb0e8..98a665e3 100644 --- a/src/Model/Company.php +++ b/src/Model/Company.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -97,13 +100,79 @@ class Company implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'required' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -150,9 +219,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -199,9 +268,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -248,34 +317,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) { @@ -323,30 +421,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -356,7 +456,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) @@ -368,6 +470,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -377,7 +480,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) @@ -389,6 +494,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -398,7 +504,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) @@ -410,6 +518,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -419,7 +528,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) @@ -431,6 +542,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -440,7 +552,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) @@ -452,6 +566,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -461,7 +576,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) @@ -473,6 +590,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -482,7 +600,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) @@ -494,6 +614,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -503,7 +624,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) @@ -515,6 +638,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -524,7 +648,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) @@ -536,6 +662,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -545,7 +672,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) @@ -557,6 +686,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -566,7 +696,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) @@ -578,6 +710,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -587,7 +720,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) @@ -599,6 +734,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -608,7 +744,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) @@ -620,6 +758,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -629,7 +768,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) @@ -641,6 +782,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -650,7 +792,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) @@ -662,6 +806,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -671,7 +816,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) @@ -683,6 +830,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -692,7 +840,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) @@ -704,6 +854,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -713,7 +864,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) @@ -725,6 +878,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -734,7 +888,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) @@ -746,6 +902,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -755,7 +912,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) @@ -767,6 +926,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -776,7 +936,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) @@ -788,6 +950,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -797,7 +960,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -809,6 +974,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -818,7 +984,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) @@ -830,6 +998,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -839,7 +1008,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -851,6 +1022,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -860,7 +1032,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) @@ -872,6 +1046,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -881,7 +1056,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) @@ -893,6 +1070,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -902,7 +1080,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) @@ -914,6 +1094,7 @@ public function setRecipientId($recipient_id) /** * Gets required + * * @return string */ public function getRequired() @@ -923,7 +1104,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) @@ -935,6 +1118,7 @@ public function setRequired($required) /** * Gets status + * * @return string */ public function getStatus() @@ -944,7 +1128,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) @@ -956,6 +1142,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -965,7 +1152,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -977,6 +1166,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -986,7 +1176,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) @@ -998,6 +1190,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1007,7 +1200,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) @@ -1019,6 +1214,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1028,7 +1224,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1040,6 +1238,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1049,7 +1248,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) @@ -1061,6 +1262,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1070,7 +1272,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) @@ -1082,6 +1286,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1091,7 +1296,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1103,6 +1310,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1112,7 +1320,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) @@ -1124,6 +1334,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -1133,7 +1344,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1145,6 +1358,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1154,7 +1368,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1166,6 +1382,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1175,7 +1392,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) @@ -1187,6 +1406,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1196,7 +1416,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) @@ -1207,7 +1429,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) @@ -1217,7 +1441,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1227,8 +1453,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1242,7 +1470,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1252,16 +1482,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 b4ede398..4db400e4 100644 --- a/src/Model/CompositeTemplate.php +++ b/src/Model/CompositeTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5d6720eb..778bfffc 100644 --- a/src/Model/ConnectConfigResults.php +++ b/src/Model/ConnectConfigResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 50d33233..2b391b1b 100644 --- a/src/Model/ConnectCustomConfiguration.php +++ b/src/Model/ConnectCustomConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -78,13 +81,60 @@ 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, + 'all_users' => null, + 'configuration_type' => null, + 'connect_id' => null, + 'enable_log' => null, + 'envelope_events' => 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, + 'recipient_events' => null, + 'requires_acknowledgement' => null, + 'sign_message_with_x509_certificate' => null, + 'soap_namespace' => null, + 'url_to_publish_to' => null, + 'user_ids' => 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 = [ @@ -112,9 +162,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'useSoapInterface' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -142,9 +192,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'setUseSoapInterface' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -172,34 +222,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) { @@ -228,30 +307,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -261,7 +342,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) @@ -273,6 +356,7 @@ public function setAllowEnvelopePublish($allow_envelope_publish) /** * Gets all_users + * * @return string */ public function getAllUsers() @@ -282,7 +366,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) @@ -294,6 +380,7 @@ public function setAllUsers($all_users) /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -303,7 +390,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) @@ -315,6 +404,7 @@ public function setConfigurationType($configuration_type) /** * Gets connect_id + * * @return string */ public function getConnectId() @@ -324,7 +414,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) @@ -336,6 +428,7 @@ public function setConnectId($connect_id) /** * Gets enable_log + * * @return string */ public function getEnableLog() @@ -345,7 +438,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) @@ -357,6 +452,7 @@ public function setEnableLog($enable_log) /** * Gets envelope_events + * * @return string */ public function getEnvelopeEvents() @@ -366,7 +462,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) @@ -378,6 +476,7 @@ public function setEnvelopeEvents($envelope_events) /** * Gets include_certificate_of_completion + * * @return string */ public function getIncludeCertificateOfCompletion() @@ -387,7 +486,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) @@ -399,6 +500,7 @@ public function setIncludeCertificateOfCompletion($include_certificate_of_comple /** * Gets include_cert_soap_header + * * @return string */ public function getIncludeCertSoapHeader() @@ -408,7 +510,9 @@ public function getIncludeCertSoapHeader() /** * Sets include_cert_soap_header + * * @param string $include_cert_soap_header + * * @return $this */ public function setIncludeCertSoapHeader($include_cert_soap_header) @@ -420,6 +524,7 @@ public function setIncludeCertSoapHeader($include_cert_soap_header) /** * Gets include_document_fields + * * @return string */ public function getIncludeDocumentFields() @@ -429,7 +534,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) @@ -441,6 +548,7 @@ public function setIncludeDocumentFields($include_document_fields) /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -450,7 +558,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) @@ -462,6 +572,7 @@ public function setIncludeDocuments($include_documents) /** * Gets include_envelope_void_reason + * * @return string */ public function getIncludeEnvelopeVoidReason() @@ -471,7 +582,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) @@ -483,6 +596,7 @@ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) /** * Gets include_hmac + * * @return string */ public function getIncludeHmac() @@ -492,7 +606,9 @@ public function getIncludeHmac() /** * Sets include_hmac + * * @param string $include_hmac + * * @return $this */ public function setIncludeHmac($include_hmac) @@ -504,6 +620,7 @@ public function setIncludeHmac($include_hmac) /** * Gets include_sender_accountas_custom_field + * * @return string */ public function getIncludeSenderAccountasCustomField() @@ -513,7 +630,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) @@ -525,6 +644,7 @@ public function setIncludeSenderAccountasCustomField($include_sender_accountas_c /** * Gets include_time_zone_information + * * @return string */ public function getIncludeTimeZoneInformation() @@ -534,7 +654,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) @@ -546,6 +668,7 @@ public function setIncludeTimeZoneInformation($include_time_zone_information) /** * Gets name + * * @return string */ public function getName() @@ -555,7 +678,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) @@ -567,6 +692,7 @@ public function setName($name) /** * Gets recipient_events + * * @return string */ public function getRecipientEvents() @@ -576,7 +702,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) @@ -588,6 +716,7 @@ public function setRecipientEvents($recipient_events) /** * Gets requires_acknowledgement + * * @return string */ public function getRequiresAcknowledgement() @@ -597,7 +726,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) @@ -609,6 +740,7 @@ public function setRequiresAcknowledgement($requires_acknowledgement) /** * Gets sign_message_with_x509_certificate + * * @return string */ public function getSignMessageWithX509Certificate() @@ -618,7 +750,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) @@ -630,6 +764,7 @@ public function setSignMessageWithX509Certificate($sign_message_with_x509_certif /** * Gets soap_namespace + * * @return string */ public function getSoapNamespace() @@ -639,7 +774,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) @@ -651,6 +788,7 @@ public function setSoapNamespace($soap_namespace) /** * Gets url_to_publish_to + * * @return string */ public function getUrlToPublishTo() @@ -660,7 +798,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) @@ -672,6 +812,7 @@ public function setUrlToPublishTo($url_to_publish_to) /** * Gets user_ids + * * @return string */ public function getUserIds() @@ -681,7 +822,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) @@ -693,6 +836,7 @@ public function setUserIds($user_ids) /** * Gets use_soap_interface + * * @return string */ public function getUseSoapInterface() @@ -702,7 +846,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) @@ -713,7 +859,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) @@ -723,7 +871,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -733,8 +883,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -748,7 +900,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -758,16 +912,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 22e4a0af..5b79f680 100644 --- a/src/Model/ConnectDebugLog.php +++ b/src/Model/ConnectDebugLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/ConnectFailureFilter.php b/src/Model/ConnectFailureFilter.php index 99917f0c..bca11b30 100644 --- a/src/Model/ConnectFailureFilter.php +++ b/src/Model/ConnectFailureFilter.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3e890c2a..2fa92d38 100644 --- a/src/Model/ConnectFailureResult.php +++ b/src/Model/ConnectFailureResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3317935d..6c744405 100644 --- a/src/Model/ConnectFailureResults.php +++ b/src/Model/ConnectFailureResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0326e960..64ab50bc 100644 --- a/src/Model/ConnectLog.php +++ b/src/Model/ConnectLog.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6f98687b..ff2b9e43 100644 --- a/src/Model/ConnectLogs.php +++ b/src/Model/ConnectLogs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/ConsoleViewRequest.php b/src/Model/ConsoleViewRequest.php index 349b59d1..7b78afb5 100644 --- a/src/Model/ConsoleViewRequest.php +++ b/src/Model/ConsoleViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 8f7633b0..804402f3 100644 --- a/src/Model/ConsumerDisclosure.php +++ b/src/Model/ConsumerDisclosure.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9398cbd7..6e03062e 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -66,13 +69,48 @@ class Contact implements ArrayAccess 'signing_group_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'contact_id' => null, + 'contact_phone_numbers' => null, + 'contact_uri' => null, + 'emails' => null, + 'error_details' => 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 = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'signing_group_name' => 'signingGroupName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'signing_group_name' => 'setSigningGroupName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,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) { @@ -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 contact_id + * * @return string */ public function getContactId() @@ -201,7 +270,9 @@ public function getContactId() /** * Sets contact_id + * * @param string $contact_id + * * @return $this */ public function setContactId($contact_id) @@ -213,6 +284,7 @@ public function setContactId($contact_id) /** * Gets contact_phone_numbers + * * @return \DocuSign\eSign\Model\ContactPhoneNumber[] */ public function getContactPhoneNumbers() @@ -222,7 +294,9 @@ public function getContactPhoneNumbers() /** * Sets contact_phone_numbers + * * @param \DocuSign\eSign\Model\ContactPhoneNumber[] $contact_phone_numbers + * * @return $this */ public function setContactPhoneNumbers($contact_phone_numbers) @@ -234,6 +308,7 @@ public function setContactPhoneNumbers($contact_phone_numbers) /** * Gets contact_uri + * * @return string */ public function getContactUri() @@ -243,7 +318,9 @@ public function getContactUri() /** * Sets contact_uri + * * @param string $contact_uri + * * @return $this */ public function setContactUri($contact_uri) @@ -255,6 +332,7 @@ public function setContactUri($contact_uri) /** * Gets emails + * * @return string[] */ public function getEmails() @@ -264,7 +342,9 @@ public function getEmails() /** * Sets emails + * * @param string[] $emails + * * @return $this */ public function setEmails($emails) @@ -276,6 +356,7 @@ public function setEmails($emails) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -285,7 +366,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) @@ -297,6 +380,7 @@ public function setErrorDetails($error_details) /** * Gets name + * * @return string */ public function getName() @@ -306,7 +390,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -318,6 +404,7 @@ public function setName($name) /** * Gets organization + * * @return string */ public function getOrganization() @@ -327,7 +414,9 @@ public function getOrganization() /** * Sets organization + * * @param string $organization + * * @return $this */ public function setOrganization($organization) @@ -339,6 +428,7 @@ public function setOrganization($organization) /** * Gets shared + * * @return string */ public function getShared() @@ -348,7 +438,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -360,6 +452,7 @@ public function setShared($shared) /** * Gets signing_group + * * @return string */ public function getSigningGroup() @@ -369,7 +462,9 @@ public function getSigningGroup() /** * Sets signing_group + * * @param string $signing_group + * * @return $this */ public function setSigningGroup($signing_group) @@ -381,6 +476,7 @@ public function setSigningGroup($signing_group) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -390,7 +486,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) @@ -401,7 +499,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) @@ -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/ContactGetResponse.php b/src/Model/ContactGetResponse.php index d0bc3478..f2315685 100644 --- a/src/Model/ContactGetResponse.php +++ b/src/Model/ContactGetResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 adc281f3..289a575c 100644 --- a/src/Model/ContactModRequest.php +++ b/src/Model/ContactModRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ '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/ContactPhoneNumber.php b/src/Model/ContactPhoneNumber.php index 1587bb54..5512c78e 100644 --- a/src/Model/ContactPhoneNumber.php +++ b/src/Model/ContactPhoneNumber.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 af86bb39..374374a4 100644 --- a/src/Model/ContactUpdateResponse.php +++ b/src/Model/ContactUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c9b6371c..1821d63e 100644 --- a/src/Model/CorrectViewRequest.php +++ b/src/Model/CorrectViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 7a3fd5ee..eae45bfb 100644 --- a/src/Model/Country.php +++ b/src/Model/Country.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 15a96259..78c081ba 100644 --- a/src/Model/CreditCardInformation.php +++ b/src/Model/CreditCardInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -62,13 +65,44 @@ 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, + '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 = [ @@ -80,9 +114,9 @@ public static function swaggerTypes() 'name_on_card' => 'nameOnCard' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'name_on_card' => 'setNameOnCard' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,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) { @@ -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 address + * * @return \DocuSign\eSign\Model\AddressInformation */ public function getAddress() @@ -181,7 +246,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) @@ -193,6 +260,7 @@ public function setAddress($address) /** * Gets card_number + * * @return string */ public function getCardNumber() @@ -202,7 +270,9 @@ public function getCardNumber() /** * Sets card_number + * * @param string $card_number The number on the credit card. + * * @return $this */ public function setCardNumber($card_number) @@ -214,6 +284,7 @@ public function setCardNumber($card_number) /** * Gets card_type + * * @return string */ public function getCardType() @@ -223,7 +294,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) @@ -235,6 +308,7 @@ public function setCardType($card_type) /** * Gets expiration_month + * * @return string */ public function getExpirationMonth() @@ -244,7 +318,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) @@ -256,6 +332,7 @@ public function setExpirationMonth($expiration_month) /** * Gets expiration_year + * * @return string */ public function getExpirationYear() @@ -265,7 +342,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) @@ -277,6 +356,7 @@ public function setExpirationYear($expiration_year) /** * Gets name_on_card + * * @return string */ public function getNameOnCard() @@ -286,7 +366,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) @@ -297,7 +379,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) @@ -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/CreditCardTypes.php b/src/Model/CreditCardTypes.php index 6fd16fcc..4d12682c 100644 --- a/src/Model/CreditCardTypes.php +++ b/src/Model/CreditCardTypes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ff227367..0b7cf41f 100644 --- a/src/Model/CurrencyFeatureSetPrice.php +++ b/src/Model/CurrencyFeatureSetPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 bd08a4ce..673d4ef0 100644 --- a/src/Model/CurrencyPlanPrice.php +++ b/src/Model/CurrencyPlanPrice.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 107ecdb9..efd6202e 100644 --- a/src/Model/CustomField.php +++ b/src/Model/CustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/CustomFieldV2.php b/src/Model/CustomFieldV2.php index 2c2e8f66..fe06df1e 100644 --- a/src/Model/CustomFieldV2.php +++ b/src/Model/CustomFieldV2.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * CustomFieldV2 Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class CustomFieldV2 implements ArrayAccess +class CustomFieldV2 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'customField_v2'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -63,13 +66,45 @@ class CustomFieldV2 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 + * * @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 + * * @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 + * * @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/CustomFields.php b/src/Model/CustomFields.php index 46b80f89..25ceff3e 100644 --- a/src/Model/CustomFields.php +++ b/src/Model/CustomFields.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 028813e9..0cd47a82 100644 --- a/src/Model/CustomFieldsEnvelope.php +++ b/src/Model/CustomFieldsEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b77b18cd..5105921e 100644 --- a/src/Model/CustomSettingsInformation.php +++ b/src/Model/CustomSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b6d353f2..e20f0046 100644 --- a/src/Model/Date.php +++ b/src/Model/Date.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -103,13 +106,85 @@ class Date implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -162,9 +237,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -217,9 +292,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -272,34 +347,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) { @@ -353,30 +457,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -386,7 +492,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) @@ -398,6 +506,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -407,7 +516,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) @@ -419,6 +530,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -428,7 +540,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) @@ -440,6 +554,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -449,7 +564,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) @@ -461,6 +578,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -470,7 +588,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) @@ -482,6 +602,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -491,7 +612,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) @@ -503,6 +626,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -512,7 +636,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) @@ -524,6 +650,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -533,7 +660,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) @@ -545,6 +674,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -554,7 +684,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) @@ -566,6 +698,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -575,7 +708,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) @@ -587,6 +722,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -596,7 +732,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) @@ -608,6 +746,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -617,7 +756,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) @@ -629,6 +770,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -638,7 +780,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) @@ -650,6 +794,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -659,7 +804,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) @@ -671,6 +818,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -680,7 +828,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) @@ -692,6 +842,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -701,7 +852,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) @@ -713,6 +866,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -722,7 +876,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) @@ -734,6 +890,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -743,7 +900,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) @@ -755,6 +914,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -764,7 +924,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) @@ -776,6 +938,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -785,7 +948,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) @@ -797,6 +962,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -806,7 +972,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) @@ -818,6 +986,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -827,7 +996,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -839,6 +1010,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -848,7 +1020,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) @@ -860,6 +1034,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -869,7 +1044,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -881,6 +1058,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -890,7 +1068,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) @@ -902,6 +1082,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -911,7 +1092,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) @@ -923,6 +1106,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -932,7 +1116,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) @@ -944,6 +1130,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -953,7 +1140,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) @@ -965,6 +1154,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -974,7 +1164,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) @@ -986,6 +1178,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -995,7 +1188,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) @@ -1007,6 +1202,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1016,7 +1212,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) @@ -1028,6 +1226,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1037,7 +1236,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1049,6 +1250,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1058,7 +1260,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) @@ -1070,6 +1274,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1079,7 +1284,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1091,6 +1298,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1100,7 +1308,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) @@ -1112,6 +1322,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1121,7 +1332,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) @@ -1133,6 +1346,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1142,7 +1356,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1154,6 +1370,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1163,7 +1380,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) @@ -1175,6 +1394,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1184,7 +1404,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) @@ -1196,6 +1418,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1205,7 +1428,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1217,6 +1442,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1226,7 +1452,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) @@ -1238,6 +1466,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1247,7 +1476,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) @@ -1259,6 +1490,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1268,7 +1500,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) @@ -1280,6 +1514,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1289,7 +1524,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1301,6 +1538,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1310,7 +1548,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1322,6 +1562,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1331,7 +1572,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) @@ -1343,6 +1586,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1352,7 +1596,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) @@ -1363,7 +1609,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) @@ -1373,7 +1621,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1383,8 +1633,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1398,7 +1650,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1408,16 +1662,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 1e582d4e..c48d460a 100644 --- a/src/Model/DateSigned.php +++ b/src/Model/DateSigned.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -90,13 +93,72 @@ class DateSigned implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => 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 = [ @@ -136,9 +198,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -178,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -220,34 +282,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) { @@ -288,30 +379,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -321,7 +414,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) @@ -333,6 +428,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -342,7 +438,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) @@ -354,6 +452,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -363,7 +462,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) @@ -375,6 +476,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -384,7 +486,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) @@ -396,6 +500,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -405,7 +510,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) @@ -417,6 +524,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -426,7 +534,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) @@ -438,6 +548,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -447,7 +558,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) @@ -459,6 +572,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -468,7 +582,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) @@ -480,6 +596,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -489,7 +606,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) @@ -501,6 +620,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -510,7 +630,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) @@ -522,6 +644,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -531,7 +654,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) @@ -543,6 +668,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -552,7 +678,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) @@ -564,6 +692,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -573,7 +702,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) @@ -585,6 +716,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -594,7 +726,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) @@ -606,6 +740,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -615,7 +750,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) @@ -627,6 +764,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -636,7 +774,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) @@ -648,6 +788,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -657,7 +798,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) @@ -669,6 +812,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -678,7 +822,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) @@ -690,6 +836,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -699,7 +846,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) @@ -711,6 +860,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -720,7 +870,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -732,6 +884,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -741,7 +894,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) @@ -753,6 +908,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -762,7 +918,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) @@ -774,6 +932,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -783,7 +942,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) @@ -795,6 +956,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -804,7 +966,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -816,6 +980,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -825,7 +990,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) @@ -837,6 +1004,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -846,7 +1014,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) @@ -858,6 +1028,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -867,7 +1038,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -879,6 +1052,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -888,7 +1062,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) @@ -900,6 +1076,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -909,7 +1086,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) @@ -921,6 +1100,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -930,7 +1110,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -942,6 +1124,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -951,7 +1134,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) @@ -963,6 +1148,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -972,7 +1158,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -984,6 +1172,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -993,7 +1182,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) @@ -1005,6 +1196,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1014,7 +1206,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) @@ -1025,7 +1219,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) @@ -1035,7 +1231,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1045,8 +1243,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1060,7 +1260,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1070,16 +1272,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 09175d2d..2f59a2bf 100644 --- a/src/Model/DateStampProperties.php +++ b/src/Model/DateStampProperties.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 fc6ed8a4..3bdd21dc 100644 --- a/src/Model/Decline.php +++ b/src/Model/Decline.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -92,13 +95,74 @@ class Decline implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'button_text' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'decline_reason' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'height' => 'int32', + 'italic' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'width' => 'int32', + '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 = [ @@ -140,9 +204,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -184,9 +248,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -228,34 +292,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) { @@ -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 anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -331,7 +426,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) @@ -343,6 +440,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -352,7 +450,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) @@ -364,6 +464,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -373,7 +474,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) @@ -385,6 +488,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -394,7 +498,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) @@ -406,6 +512,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -415,7 +522,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) @@ -427,6 +536,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -436,7 +546,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) @@ -448,6 +560,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -457,7 +570,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) @@ -469,6 +584,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -478,7 +594,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) @@ -490,6 +608,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -499,7 +618,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) @@ -511,6 +632,7 @@ public function setBold($bold) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -520,7 +642,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) @@ -532,6 +656,7 @@ public function setButtonText($button_text) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -541,7 +666,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) @@ -553,6 +680,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -562,7 +690,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) @@ -574,6 +704,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -583,7 +714,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) @@ -595,6 +728,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets decline_reason + * * @return string */ public function getDeclineReason() @@ -604,7 +738,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) @@ -616,6 +752,7 @@ public function setDeclineReason($decline_reason) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -625,7 +762,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) @@ -637,6 +776,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -646,7 +786,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) @@ -658,6 +800,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -667,7 +810,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) @@ -679,6 +824,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -688,7 +834,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) @@ -700,6 +848,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -709,7 +858,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) @@ -721,6 +872,7 @@ public function setFontSize($font_size) /** * Gets height + * * @return int */ public function getHeight() @@ -730,7 +882,9 @@ public function getHeight() /** * Sets height + * * @param int $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -742,6 +896,7 @@ public function setHeight($height) /** * Gets italic + * * @return string */ public function getItalic() @@ -751,7 +906,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) @@ -763,6 +920,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -772,7 +930,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) @@ -784,6 +944,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -793,7 +954,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) @@ -805,6 +968,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -814,7 +978,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) @@ -826,6 +992,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -835,7 +1002,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) @@ -847,6 +1016,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -856,7 +1026,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -868,6 +1040,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -877,7 +1050,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) @@ -889,6 +1064,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -898,7 +1074,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) @@ -910,6 +1088,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -919,7 +1098,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -931,6 +1112,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -940,7 +1122,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) @@ -952,6 +1136,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -961,7 +1146,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) @@ -973,6 +1160,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -982,7 +1170,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -994,6 +1184,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1003,7 +1194,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) @@ -1015,6 +1208,7 @@ public function setUnderline($underline) /** * Gets width + * * @return int */ public function getWidth() @@ -1024,7 +1218,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1036,6 +1232,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1045,7 +1242,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) @@ -1057,6 +1256,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1066,7 +1266,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) @@ -1077,7 +1279,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) @@ -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/DiagnosticsSettingsInformation.php b/src/Model/DiagnosticsSettingsInformation.php index 7549cdb3..400c0a03 100644 --- a/src/Model/DiagnosticsSettingsInformation.php +++ b/src/Model/DiagnosticsSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/DobInformationInput.php b/src/Model/DobInformationInput.php index b4cbeb02..8e8843ab 100644 --- a/src/Model/DobInformationInput.php +++ b/src/Model/DobInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 07ae9004..f747c4c6 100644 --- a/src/Model/Document.php +++ b/src/Model/Document.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -78,13 +81,60 @@ 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, + 'authoritative_copy' => 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, + 'remote_url' => null, + 'signer_must_acknowledge' => 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 = [ @@ -112,9 +162,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -142,9 +192,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -172,34 +222,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) { @@ -228,30 +307,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -261,7 +342,9 @@ public function getApplyAnchorTabs() /** * Sets apply_anchor_tabs + * * @param string $apply_anchor_tabs Reserved: TBD + * * @return $this */ public function setApplyAnchorTabs($apply_anchor_tabs) @@ -273,6 +356,7 @@ public function setApplyAnchorTabs($apply_anchor_tabs) /** * Gets authoritative_copy + * * @return bool */ public function getAuthoritativeCopy() @@ -282,7 +366,9 @@ public function getAuthoritativeCopy() /** * Sets authoritative_copy + * * @param bool $authoritative_copy Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. + * * @return $this */ public function setAuthoritativeCopy($authoritative_copy) @@ -294,6 +380,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets display + * * @return string */ public function getDisplay() @@ -303,7 +390,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -315,6 +404,7 @@ public function setDisplay($display) /** * Gets document_base64 + * * @return string */ public function getDocumentBase64() @@ -324,7 +414,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) @@ -336,6 +428,7 @@ public function setDocumentBase64($document_base64) /** * Gets document_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getDocumentFields() @@ -345,7 +438,9 @@ public function getDocumentFields() /** * Sets document_fields + * * @param \DocuSign\eSign\Model\NameValue[] $document_fields + * * @return $this */ public function setDocumentFields($document_fields) @@ -357,6 +452,7 @@ public function setDocumentFields($document_fields) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -366,7 +462,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) @@ -378,6 +476,7 @@ public function setDocumentId($document_id) /** * Gets encrypted_with_key_manager + * * @return string */ public function getEncryptedWithKeyManager() @@ -387,7 +486,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) @@ -399,6 +500,7 @@ public function setEncryptedWithKeyManager($encrypted_with_key_manager) /** * Gets file_extension + * * @return string */ public function getFileExtension() @@ -408,7 +510,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) @@ -420,6 +524,7 @@ public function setFileExtension($file_extension) /** * Gets file_format_hint + * * @return string */ public function getFileFormatHint() @@ -429,7 +534,9 @@ public function getFileFormatHint() /** * Sets file_format_hint + * * @param string $file_format_hint + * * @return $this */ public function setFileFormatHint($file_format_hint) @@ -441,6 +548,7 @@ public function setFileFormatHint($file_format_hint) /** * Gets html_definition + * * @return \DocuSign\eSign\Model\DocumentHtmlDefinition */ public function getHtmlDefinition() @@ -450,7 +558,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) @@ -462,6 +572,7 @@ public function setHtmlDefinition($html_definition) /** * Gets include_in_download + * * @return string */ public function getIncludeInDownload() @@ -471,7 +582,9 @@ public function getIncludeInDownload() /** * Sets include_in_download + * * @param string $include_in_download + * * @return $this */ public function setIncludeInDownload($include_in_download) @@ -483,6 +596,7 @@ public function setIncludeInDownload($include_in_download) /** * Gets match_boxes + * * @return \DocuSign\eSign\Model\MatchBox[] */ public function getMatchBoxes() @@ -492,7 +606,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) @@ -504,6 +620,7 @@ public function setMatchBoxes($match_boxes) /** * Gets name + * * @return string */ public function getName() @@ -513,7 +630,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -525,6 +644,7 @@ public function setName($name) /** * Gets order + * * @return string */ public function getOrder() @@ -534,7 +654,9 @@ public function getOrder() /** * Sets order + * * @param string $order + * * @return $this */ public function setOrder($order) @@ -546,6 +668,7 @@ public function setOrder($order) /** * Gets pages + * * @return string */ public function getPages() @@ -555,7 +678,9 @@ public function getPages() /** * Sets pages + * * @param string $pages + * * @return $this */ public function setPages($pages) @@ -567,6 +692,7 @@ public function setPages($pages) /** * Gets password + * * @return string */ public function getPassword() @@ -576,7 +702,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -588,6 +716,7 @@ public function setPassword($password) /** * Gets remote_url + * * @return string */ public function getRemoteUrl() @@ -597,7 +726,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) @@ -609,6 +740,7 @@ public function setRemoteUrl($remote_url) /** * Gets signer_must_acknowledge + * * @return string */ public function getSignerMustAcknowledge() @@ -618,7 +750,9 @@ public function getSignerMustAcknowledge() /** * Sets signer_must_acknowledge + * * @param string $signer_must_acknowledge + * * @return $this */ public function setSignerMustAcknowledge($signer_must_acknowledge) @@ -630,6 +764,7 @@ public function setSignerMustAcknowledge($signer_must_acknowledge) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -639,7 +774,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) @@ -651,6 +788,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -660,7 +798,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) @@ -672,6 +812,7 @@ public function setTemplateRequired($template_required) /** * Gets transform_pdf_fields + * * @return string */ public function getTransformPdfFields() @@ -681,7 +822,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) @@ -693,6 +836,7 @@ public function setTransformPdfFields($transform_pdf_fields) /** * Gets uri + * * @return string */ public function getUri() @@ -702,7 +846,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -713,7 +859,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) @@ -723,7 +871,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -733,8 +883,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -748,7 +900,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -758,16 +912,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 b2cd286f..d3fb174e 100644 --- a/src/Model/DocumentFieldsInformation.php +++ b/src/Model/DocumentFieldsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ffb9421c..982e1d5d 100644 --- a/src/Model/DocumentHtmlCollapsibleDisplaySettings.php +++ b/src/Model/DocumentHtmlCollapsibleDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6b362f9b..b3f41adb 100644 --- a/src/Model/DocumentHtmlDefinition.php +++ b/src/Model/DocumentHtmlDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0f337368..82a3b9df 100644 --- a/src/Model/DocumentHtmlDefinitionOriginal.php +++ b/src/Model/DocumentHtmlDefinitionOriginal.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c87097a1..c5d9cf8d 100644 --- a/src/Model/DocumentHtmlDefinitionOriginals.php +++ b/src/Model/DocumentHtmlDefinitionOriginals.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b9c193f8..9412caa7 100644 --- a/src/Model/DocumentHtmlDefinitions.php +++ b/src/Model/DocumentHtmlDefinitions.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 cada1ab3..d4fe962b 100644 --- a/src/Model/DocumentHtmlDisplayAnchor.php +++ b/src/Model/DocumentHtmlDisplayAnchor.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5654d7f7..e9138f42 100644 --- a/src/Model/DocumentHtmlDisplaySettings.php +++ b/src/Model/DocumentHtmlDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e5aff926..6ae877fb 100644 --- a/src/Model/DocumentTemplate.php +++ b/src/Model/DocumentTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 fe9d62e2..f3342d6d 100644 --- a/src/Model/DocumentTemplateList.php +++ b/src/Model/DocumentTemplateList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6ac2ee7b..dba888d3 100644 --- a/src/Model/DocumentVisibility.php +++ b/src/Model/DocumentVisibility.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9909ad4d..8c433119 100644 --- a/src/Model/DocumentVisibilityList.php +++ b/src/Model/DocumentVisibilityList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/ENoteConfiguration.php b/src/Model/ENoteConfiguration.php index 5e2365bf..fa8a7b94 100644 --- a/src/Model/ENoteConfiguration.php +++ b/src/Model/ENoteConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 42d3c46f..cc377800 100644 --- a/src/Model/Editor.php +++ b/src/Model/Editor.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -73,6 +76,7 @@ class Editor implements ArrayAccess 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'name' => 'string', @@ -100,13 +104,83 @@ 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, + 'add_access_code_to_email' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -129,6 +203,7 @@ public static function swaggerTypes() 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'name' => 'name', @@ -156,9 +231,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -181,6 +256,7 @@ public static function swaggerTypes() 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'name' => 'setName', @@ -208,9 +284,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -233,6 +309,7 @@ public static function swaggerTypes() 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'name' => 'getName', @@ -260,34 +337,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) { @@ -310,6 +416,7 @@ public function __construct(array $data = null) $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : null; @@ -338,30 +445,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -371,7 +480,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) @@ -383,6 +494,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -392,7 +504,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) @@ -404,6 +518,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -413,7 +528,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) @@ -425,6 +542,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -434,7 +552,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) @@ -446,6 +566,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -455,7 +576,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) @@ -467,6 +590,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -476,7 +600,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) @@ -488,6 +614,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -497,7 +624,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) @@ -509,6 +638,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -518,7 +648,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -530,6 +662,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -539,7 +672,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -551,6 +686,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -560,7 +696,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) @@ -572,6 +710,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -581,7 +720,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) @@ -593,6 +734,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -602,7 +744,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -614,6 +758,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -623,7 +768,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) @@ -635,6 +782,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -644,7 +792,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) @@ -656,6 +806,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -665,7 +816,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -677,6 +830,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -686,7 +840,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) @@ -698,6 +854,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -707,7 +864,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -719,6 +878,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -728,7 +888,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) @@ -740,6 +902,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -749,7 +912,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) @@ -759,8 +924,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() @@ -770,7 +960,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) @@ -782,6 +974,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -791,7 +984,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -803,6 +998,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -812,7 +1008,9 @@ public function getName() /** * Sets name + * * @param string $name legal name of the recipient. Maximum Length: 100 characters. + * * @return $this */ public function setName($name) @@ -824,6 +1022,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -833,7 +1032,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) @@ -845,6 +1046,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -854,7 +1056,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) @@ -866,6 +1070,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -875,7 +1080,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -887,6 +1094,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -896,7 +1104,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) @@ -908,6 +1118,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -917,7 +1128,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) @@ -929,6 +1142,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -938,7 +1152,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -950,6 +1166,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -959,7 +1176,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) @@ -971,6 +1190,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -980,7 +1200,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -992,6 +1214,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1001,7 +1224,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) @@ -1013,6 +1238,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1022,7 +1248,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1034,6 +1262,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1043,7 +1272,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) @@ -1055,6 +1286,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1064,7 +1296,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) @@ -1076,6 +1310,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1085,7 +1320,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) @@ -1097,6 +1334,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1106,7 +1344,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) @@ -1118,6 +1358,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1127,7 +1368,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) @@ -1139,6 +1382,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1148,7 +1392,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) @@ -1160,6 +1406,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1169,7 +1416,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) @@ -1181,6 +1430,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1190,7 +1440,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) @@ -1202,6 +1454,7 @@ public function setStatus($status) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1211,7 +1464,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) @@ -1223,6 +1478,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1232,7 +1488,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) @@ -1244,6 +1502,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1253,7 +1512,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1265,6 +1526,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1274,7 +1536,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1285,7 +1549,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) @@ -1295,7 +1561,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1305,8 +1573,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1320,7 +1590,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1330,16 +1602,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 29292119..4aaf2cf3 100644 --- a/src/Model/Email.php +++ b/src/Model/Email.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -103,13 +106,85 @@ class Email implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -162,9 +237,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -217,9 +292,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -272,34 +347,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) { @@ -353,30 +457,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -386,7 +492,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) @@ -398,6 +506,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -407,7 +516,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) @@ -419,6 +530,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -428,7 +540,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) @@ -440,6 +554,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -449,7 +564,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) @@ -461,6 +578,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -470,7 +588,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) @@ -482,6 +602,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -491,7 +612,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) @@ -503,6 +626,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -512,7 +636,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) @@ -524,6 +650,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -533,7 +660,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) @@ -545,6 +674,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -554,7 +684,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) @@ -566,6 +698,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -575,7 +708,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) @@ -587,6 +722,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -596,7 +732,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) @@ -608,6 +746,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -617,7 +756,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) @@ -629,6 +770,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -638,7 +780,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) @@ -650,6 +794,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -659,7 +804,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) @@ -671,6 +818,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -680,7 +828,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) @@ -692,6 +842,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -701,7 +852,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) @@ -713,6 +866,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -722,7 +876,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) @@ -734,6 +890,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -743,7 +900,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) @@ -755,6 +914,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -764,7 +924,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) @@ -776,6 +938,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -785,7 +948,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) @@ -797,6 +962,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -806,7 +972,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) @@ -818,6 +986,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -827,7 +996,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -839,6 +1010,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -848,7 +1020,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) @@ -860,6 +1034,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -869,7 +1044,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -881,6 +1058,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -890,7 +1068,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) @@ -902,6 +1082,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -911,7 +1092,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) @@ -923,6 +1106,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -932,7 +1116,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) @@ -944,6 +1130,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -953,7 +1140,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) @@ -965,6 +1154,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -974,7 +1164,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) @@ -986,6 +1178,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -995,7 +1188,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) @@ -1007,6 +1202,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1016,7 +1212,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) @@ -1028,6 +1226,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1037,7 +1236,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1049,6 +1250,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1058,7 +1260,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) @@ -1070,6 +1274,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1079,7 +1284,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1091,6 +1298,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1100,7 +1308,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) @@ -1112,6 +1322,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1121,7 +1332,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) @@ -1133,6 +1346,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1142,7 +1356,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1154,6 +1370,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1163,7 +1380,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) @@ -1175,6 +1394,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1184,7 +1404,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) @@ -1196,6 +1418,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1205,7 +1428,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1217,6 +1442,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1226,7 +1452,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) @@ -1238,6 +1466,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1247,7 +1476,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) @@ -1259,6 +1490,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1268,7 +1500,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) @@ -1280,6 +1514,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1289,7 +1524,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1301,6 +1538,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1310,7 +1548,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1322,6 +1562,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1331,7 +1572,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) @@ -1343,6 +1586,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1352,7 +1596,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) @@ -1363,7 +1609,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) @@ -1373,7 +1621,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1383,8 +1633,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1398,7 +1650,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1408,16 +1662,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 298dd42e..c9cc5cc8 100644 --- a/src/Model/EmailAddress.php +++ b/src/Model/EmailAddress.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -90,13 +93,72 @@ class EmailAddress implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => 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 = [ @@ -136,9 +198,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -178,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -220,34 +282,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) { @@ -288,30 +379,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -321,7 +414,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) @@ -333,6 +428,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -342,7 +438,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) @@ -354,6 +452,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -363,7 +462,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) @@ -375,6 +476,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -384,7 +486,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) @@ -396,6 +500,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -405,7 +510,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) @@ -417,6 +524,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -426,7 +534,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) @@ -438,6 +548,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -447,7 +558,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) @@ -459,6 +572,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -468,7 +582,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) @@ -480,6 +596,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -489,7 +606,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) @@ -501,6 +620,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -510,7 +630,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) @@ -522,6 +644,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -531,7 +654,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) @@ -543,6 +668,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -552,7 +678,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) @@ -564,6 +692,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -573,7 +702,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) @@ -585,6 +716,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -594,7 +726,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) @@ -606,6 +740,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -615,7 +750,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) @@ -627,6 +764,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -636,7 +774,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) @@ -648,6 +788,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -657,7 +798,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) @@ -669,6 +812,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -678,7 +822,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) @@ -690,6 +836,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -699,7 +846,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) @@ -711,6 +860,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -720,7 +870,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -732,6 +884,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -741,7 +894,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) @@ -753,6 +908,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -762,7 +918,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) @@ -774,6 +932,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -783,7 +942,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) @@ -795,6 +956,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -804,7 +966,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -816,6 +980,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -825,7 +990,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) @@ -837,6 +1004,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -846,7 +1014,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) @@ -858,6 +1028,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -867,7 +1038,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -879,6 +1052,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -888,7 +1062,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) @@ -900,6 +1076,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -909,7 +1086,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) @@ -921,6 +1100,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -930,7 +1110,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -942,6 +1124,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -951,7 +1134,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) @@ -963,6 +1148,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -972,7 +1158,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -984,6 +1172,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -993,7 +1182,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) @@ -1005,6 +1196,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1014,7 +1206,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) @@ -1025,7 +1219,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) @@ -1035,7 +1231,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1045,8 +1243,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1060,7 +1260,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1070,16 +1272,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 6b3934d0..59d53eae 100644 --- a/src/Model/EmailSettings.php +++ b/src/Model/EmailSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9366af7c..fb328d80 100644 --- a/src/Model/Envelope.php +++ b/src/Model/Envelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -108,13 +111,90 @@ class Envelope implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_view_history' => 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_id' => null, + 'envelope_id_stamping' => null, + 'envelope_uri' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => null, + 'lock_information' => null, + 'message_lock' => null, + 'notification' => null, + 'notification_uri' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sent_date_time' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_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 = [ @@ -172,9 +252,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -232,9 +312,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -292,34 +372,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) { @@ -378,30 +487,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_markup + * * @return string */ public function getAllowMarkup() @@ -411,7 +522,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) @@ -423,6 +536,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -432,7 +546,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) @@ -444,6 +560,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -453,7 +570,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -465,6 +584,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -474,7 +594,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) @@ -486,6 +608,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -495,7 +618,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -507,6 +632,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -516,7 +642,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) @@ -528,6 +656,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -537,7 +666,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -549,6 +680,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -558,7 +690,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -570,6 +704,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -579,7 +714,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id + * * @return $this */ public function setBrandId($brand_id) @@ -591,6 +728,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -600,7 +738,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -612,6 +752,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -621,7 +762,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) @@ -633,6 +776,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -642,7 +786,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) @@ -654,6 +800,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -663,7 +810,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -675,6 +824,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -684,7 +834,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) @@ -696,6 +848,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -705,7 +858,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) @@ -717,6 +872,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -726,7 +882,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) @@ -738,6 +896,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -747,7 +906,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) @@ -759,6 +920,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -768,7 +930,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) @@ -780,6 +944,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -789,7 +954,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) @@ -801,6 +968,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -810,7 +978,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -822,6 +992,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -831,7 +1002,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -843,6 +1016,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -852,7 +1026,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) @@ -864,6 +1040,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -873,7 +1050,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) @@ -885,6 +1064,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -894,7 +1074,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) @@ -906,6 +1088,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -915,7 +1098,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) @@ -927,6 +1112,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -936,7 +1122,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) @@ -948,6 +1136,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -957,7 +1146,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) @@ -969,6 +1160,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -978,7 +1170,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) @@ -990,6 +1184,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -999,7 +1194,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) @@ -1011,6 +1208,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1020,7 +1218,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) @@ -1032,6 +1232,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1041,7 +1242,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1053,6 +1256,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1062,7 +1266,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) @@ -1074,6 +1280,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1083,7 +1290,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1095,6 +1304,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1104,7 +1314,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) @@ -1116,6 +1328,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1125,7 +1338,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) @@ -1137,6 +1352,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1146,7 +1362,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) @@ -1158,6 +1376,7 @@ public function setMessageLock($message_lock) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1167,7 +1386,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) @@ -1179,6 +1400,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1188,7 +1410,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) @@ -1200,6 +1424,7 @@ public function setNotificationUri($notification_uri) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1209,7 +1434,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -1221,6 +1448,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -1230,7 +1458,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) @@ -1242,6 +1472,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -1251,7 +1482,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) @@ -1263,6 +1496,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -1272,7 +1506,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) @@ -1284,6 +1520,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1293,7 +1530,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) @@ -1305,6 +1544,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -1314,7 +1554,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) @@ -1326,6 +1568,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -1335,7 +1578,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) @@ -1347,6 +1592,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -1356,7 +1602,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) @@ -1368,6 +1616,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -1377,7 +1626,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) @@ -1389,6 +1640,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -1398,7 +1650,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) @@ -1410,6 +1664,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -1419,7 +1674,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) @@ -1431,6 +1688,7 @@ public function setTransactionId($transaction_id) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -1440,7 +1698,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) @@ -1452,6 +1712,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -1461,7 +1722,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) @@ -1473,6 +1736,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -1482,7 +1746,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) @@ -1493,7 +1759,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) @@ -1503,7 +1771,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1513,8 +1783,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1528,7 +1800,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1538,16 +1812,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 dd20c7ad..f1058026 100644 --- a/src/Model/EnvelopeAttachment.php +++ b/src/Model/EnvelopeAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6b68c0c8..e9dc1759 100644 --- a/src/Model/EnvelopeAttachmentsRequest.php +++ b/src/Model/EnvelopeAttachmentsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 23f33794..c88a172a 100644 --- a/src/Model/EnvelopeAttachmentsResult.php +++ b/src/Model/EnvelopeAttachmentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6bd2878d..21beb31c 100644 --- a/src/Model/EnvelopeAuditEvent.php +++ b/src/Model/EnvelopeAuditEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 22ff0b2c..cfc64278 100644 --- a/src/Model/EnvelopeAuditEventResponse.php +++ b/src/Model/EnvelopeAuditEventResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d8bb3840..a42ff99e 100644 --- a/src/Model/EnvelopeDefinition.php +++ b/src/Model/EnvelopeDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -117,13 +120,99 @@ class EnvelopeDefinition implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'accessibility' => null, + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_recipient_recursion' => null, + 'allow_view_history' => 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_id' => null, + 'envelope_id_stamping' => null, + 'envelope_uri' => null, + 'event_notification' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => null, + 'lock_information' => null, + 'message_lock' => null, + 'notification' => null, + 'notification_uri' => null, + 'password' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sent_date_time' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_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 = [ @@ -190,9 +279,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -259,9 +348,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -328,34 +417,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) { @@ -423,30 +541,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True if all properteis are valid + * @return bool True if all properties are valid */ public function valid() { - return true; + return count($this->listInvalidProperties()) === 0; } /** * Gets accessibility + * * @return string */ public function getAccessibility() @@ -456,7 +576,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) @@ -468,6 +590,7 @@ public function setAccessibility($accessibility) /** * Gets allow_markup + * * @return string */ public function getAllowMarkup() @@ -477,7 +600,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) @@ -489,6 +614,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -498,7 +624,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) @@ -510,6 +638,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_recipient_recursion + * * @return string */ public function getAllowRecipientRecursion() @@ -519,7 +648,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) @@ -531,6 +662,7 @@ public function setAllowRecipientRecursion($allow_recipient_recursion) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -540,7 +672,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -552,6 +686,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -561,7 +696,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) @@ -573,6 +710,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments + * * @return \DocuSign\eSign\Model\Attachment[] */ public function getAttachments() @@ -582,7 +720,9 @@ public function getAttachments() /** * Sets attachments + * * @param \DocuSign\eSign\Model\Attachment[] $attachments + * * @return $this */ public function setAttachments($attachments) @@ -594,6 +734,7 @@ public function setAttachments($attachments) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -603,7 +744,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -615,6 +758,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -624,7 +768,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) @@ -636,6 +782,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -645,7 +792,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -657,6 +806,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -666,7 +816,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -678,6 +830,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -687,7 +840,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) @@ -699,6 +854,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -708,7 +864,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -720,6 +878,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -729,7 +888,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) @@ -741,6 +902,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -750,7 +912,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) @@ -762,6 +926,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets composite_templates + * * @return \DocuSign\eSign\Model\CompositeTemplate[] */ public function getCompositeTemplates() @@ -771,7 +936,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) @@ -783,6 +950,7 @@ public function setCompositeTemplates($composite_templates) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -792,7 +960,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -804,6 +974,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -813,7 +984,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) @@ -825,6 +998,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -834,7 +1008,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) @@ -846,6 +1022,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -855,7 +1032,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) @@ -867,6 +1046,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -876,7 +1056,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) @@ -888,6 +1070,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -897,7 +1080,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) @@ -909,6 +1094,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -918,7 +1104,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) @@ -930,6 +1118,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -939,7 +1128,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -951,6 +1142,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -960,7 +1152,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) @@ -972,6 +1166,7 @@ public function setDocuments($documents) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -981,7 +1176,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -993,6 +1190,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -1002,7 +1200,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) @@ -1014,6 +1214,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -1023,7 +1224,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) @@ -1035,6 +1238,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -1044,7 +1248,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) @@ -1056,6 +1262,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -1065,7 +1272,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) @@ -1077,6 +1286,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -1086,7 +1296,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) @@ -1098,6 +1310,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -1107,7 +1320,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) @@ -1119,6 +1334,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1128,7 +1344,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) @@ -1140,6 +1358,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1149,7 +1368,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) @@ -1161,6 +1382,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1170,7 +1392,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) @@ -1182,6 +1406,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets event_notification + * * @return \DocuSign\eSign\Model\EventNotification */ public function getEventNotification() @@ -1191,7 +1416,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) @@ -1203,6 +1430,7 @@ public function setEventNotification($event_notification) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1212,7 +1440,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1224,6 +1454,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1233,7 +1464,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) @@ -1245,6 +1478,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1254,7 +1488,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1266,6 +1502,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1275,7 +1512,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) @@ -1287,6 +1526,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1296,7 +1536,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) @@ -1308,6 +1550,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1317,7 +1560,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) @@ -1329,6 +1574,7 @@ public function setMessageLock($message_lock) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1338,7 +1584,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) @@ -1350,6 +1598,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1359,7 +1608,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) @@ -1371,6 +1622,7 @@ public function setNotificationUri($notification_uri) /** * Gets password + * * @return string */ public function getPassword() @@ -1380,7 +1632,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -1392,6 +1646,7 @@ public function setPassword($password) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1401,7 +1656,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) @@ -1413,6 +1670,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -1422,7 +1680,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) @@ -1434,6 +1694,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -1443,7 +1704,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) @@ -1455,6 +1718,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -1464,7 +1728,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) @@ -1476,6 +1742,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1485,7 +1752,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) @@ -1497,6 +1766,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -1506,7 +1776,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) @@ -1518,6 +1790,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -1527,7 +1800,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) @@ -1539,6 +1814,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -1548,7 +1824,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) @@ -1560,6 +1838,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -1569,7 +1848,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) @@ -1581,6 +1862,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -1590,7 +1872,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) @@ -1602,6 +1886,7 @@ public function setTemplateId($template_id) /** * Gets template_roles + * * @return \DocuSign\eSign\Model\TemplateRole[] */ public function getTemplateRoles() @@ -1611,7 +1896,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) @@ -1623,6 +1910,7 @@ public function setTemplateRoles($template_roles) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -1632,7 +1920,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) @@ -1644,6 +1934,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -1653,7 +1944,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) @@ -1665,6 +1958,7 @@ public function setTransactionId($transaction_id) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -1674,7 +1968,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) @@ -1686,6 +1982,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -1695,7 +1992,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) @@ -1707,6 +2006,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -1716,7 +2016,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) @@ -1727,7 +2029,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) @@ -1737,7 +2041,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1747,8 +2053,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1762,7 +2070,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1772,16 +2082,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 a53ec819..8967eb71 100644 --- a/src/Model/EnvelopeDocument.php +++ b/src/Model/EnvelopeDocument.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -72,13 +75,54 @@ class EnvelopeDocument implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'attachment_tab_id' => null, + 'authoritative_copy' => null, + 'available_document_types' => null, + 'contains_pdf_form_fields' => null, + 'display' => null, + 'document_fields' => null, + 'document_id' => null, + 'error_details' => null, + 'include_in_download' => null, + 'name' => null, + 'order' => null, + 'pages' => null, + 'signer_must_acknowledge' => null, + 'size_bytes' => 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 = [ @@ -100,9 +144,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -124,9 +168,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -148,34 +192,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) { @@ -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 attachment_tab_id + * * @return string */ public function getAttachmentTabId() @@ -231,7 +306,9 @@ public function getAttachmentTabId() /** * Sets attachment_tab_id + * * @param string $attachment_tab_id + * * @return $this */ public function setAttachmentTabId($attachment_tab_id) @@ -243,6 +320,7 @@ public function setAttachmentTabId($attachment_tab_id) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -252,7 +330,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) @@ -264,6 +344,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets available_document_types + * * @return \DocuSign\eSign\Model\SignatureType[] */ public function getAvailableDocumentTypes() @@ -273,7 +354,9 @@ public function getAvailableDocumentTypes() /** * Sets available_document_types + * * @param \DocuSign\eSign\Model\SignatureType[] $available_document_types + * * @return $this */ public function setAvailableDocumentTypes($available_document_types) @@ -285,6 +368,7 @@ public function setAvailableDocumentTypes($available_document_types) /** * Gets contains_pdf_form_fields + * * @return string */ public function getContainsPdfFormFields() @@ -294,7 +378,9 @@ public function getContainsPdfFormFields() /** * Sets contains_pdf_form_fields + * * @param string $contains_pdf_form_fields + * * @return $this */ public function setContainsPdfFormFields($contains_pdf_form_fields) @@ -306,6 +392,7 @@ public function setContainsPdfFormFields($contains_pdf_form_fields) /** * Gets display + * * @return string */ public function getDisplay() @@ -315,7 +402,9 @@ public function getDisplay() /** * Sets display + * * @param string $display + * * @return $this */ public function setDisplay($display) @@ -327,6 +416,7 @@ public function setDisplay($display) /** * Gets document_fields + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getDocumentFields() @@ -336,7 +426,9 @@ public function getDocumentFields() /** * Sets document_fields + * * @param \DocuSign\eSign\Model\NameValue[] $document_fields + * * @return $this */ public function setDocumentFields($document_fields) @@ -348,6 +440,7 @@ public function setDocumentFields($document_fields) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -357,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) @@ -369,6 +464,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -378,7 +474,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) @@ -390,6 +488,7 @@ public function setErrorDetails($error_details) /** * Gets include_in_download + * * @return string */ public function getIncludeInDownload() @@ -399,7 +498,9 @@ public function getIncludeInDownload() /** * Sets include_in_download + * * @param string $include_in_download + * * @return $this */ public function setIncludeInDownload($include_in_download) @@ -411,6 +512,7 @@ public function setIncludeInDownload($include_in_download) /** * Gets name + * * @return string */ public function getName() @@ -420,7 +522,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -432,6 +536,7 @@ public function setName($name) /** * Gets order + * * @return string */ public function getOrder() @@ -441,7 +546,9 @@ public function getOrder() /** * Sets order + * * @param string $order + * * @return $this */ public function setOrder($order) @@ -453,6 +560,7 @@ public function setOrder($order) /** * Gets pages + * * @return string */ public function getPages() @@ -462,7 +570,9 @@ public function getPages() /** * Sets pages + * * @param string $pages + * * @return $this */ public function setPages($pages) @@ -474,6 +584,7 @@ public function setPages($pages) /** * Gets signer_must_acknowledge + * * @return string */ public function getSignerMustAcknowledge() @@ -483,7 +594,9 @@ public function getSignerMustAcknowledge() /** * Sets signer_must_acknowledge + * * @param string $signer_must_acknowledge + * * @return $this */ public function setSignerMustAcknowledge($signer_must_acknowledge) @@ -495,6 +608,7 @@ public function setSignerMustAcknowledge($signer_must_acknowledge) /** * Gets size_bytes + * * @return string */ public function getSizeBytes() @@ -504,7 +618,9 @@ public function getSizeBytes() /** * Sets size_bytes + * * @param string $size_bytes + * * @return $this */ public function setSizeBytes($size_bytes) @@ -516,6 +632,7 @@ public function setSizeBytes($size_bytes) /** * Gets type + * * @return string */ public function getType() @@ -525,7 +642,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -537,6 +656,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -546,7 +666,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -557,7 +679,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) @@ -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/EnvelopeDocumentsResult.php b/src/Model/EnvelopeDocumentsResult.php index 1af3908a..275d0205 100644 --- a/src/Model/EnvelopeDocumentsResult.php +++ b/src/Model/EnvelopeDocumentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ca404870..2b6a92c5 100644 --- a/src/Model/EnvelopeEvent.php +++ b/src/Model/EnvelopeEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3cba06cf..e3b95939 100644 --- a/src/Model/EnvelopeFormData.php +++ b/src/Model/EnvelopeFormData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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\NameValue[] */ public function getFormData() @@ -223,7 +294,9 @@ public function getFormData() /** * Sets form_data + * * @param \DocuSign\eSign\Model\NameValue[] $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 83d298ad..eae80529 100644 --- a/src/Model/EnvelopeId.php +++ b/src/Model/EnvelopeId.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -89,13 +92,71 @@ class EnvelopeId implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => 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 = [ @@ -134,9 +195,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -175,9 +236,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -216,34 +277,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) { @@ -283,30 +373,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -316,7 +408,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) @@ -328,6 +422,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -337,7 +432,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) @@ -349,6 +446,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -358,7 +456,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) @@ -370,6 +470,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -379,7 +480,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) @@ -391,6 +494,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -400,7 +504,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) @@ -412,6 +518,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -421,7 +528,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) @@ -433,6 +542,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -442,7 +552,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) @@ -454,6 +566,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -463,7 +576,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) @@ -475,6 +590,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -484,7 +600,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) @@ -496,6 +614,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -505,7 +624,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) @@ -517,6 +638,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -526,7 +648,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) @@ -538,6 +662,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -547,7 +672,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) @@ -559,6 +686,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -568,7 +696,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) @@ -580,6 +710,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -589,7 +720,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) @@ -601,6 +734,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -610,7 +744,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) @@ -622,6 +758,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -631,7 +768,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) @@ -643,6 +782,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -652,7 +792,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) @@ -664,6 +806,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -673,7 +816,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) @@ -685,6 +830,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -694,7 +840,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) @@ -706,6 +854,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -715,7 +864,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -727,6 +878,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -736,7 +888,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) @@ -748,6 +902,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -757,7 +912,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) @@ -769,6 +926,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -778,7 +936,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) @@ -790,6 +950,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -799,7 +960,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -811,6 +974,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -820,7 +984,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) @@ -832,6 +998,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -841,7 +1008,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) @@ -853,6 +1022,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -862,7 +1032,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -874,6 +1046,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -883,7 +1056,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) @@ -895,6 +1070,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -904,7 +1080,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) @@ -916,6 +1094,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -925,7 +1104,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -937,6 +1118,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -946,7 +1128,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) @@ -958,6 +1142,7 @@ public function setUnderline($underline) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -967,7 +1152,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) @@ -979,6 +1166,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -988,7 +1176,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) @@ -999,7 +1189,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) @@ -1009,7 +1201,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1019,8 +1213,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1034,7 +1230,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1044,16 +1242,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 c0a28e83..9f4fd1dc 100644 --- a/src/Model/EnvelopeIdsRequest.php +++ b/src/Model/EnvelopeIdsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/EnvelopeNotificationRequest.php b/src/Model/EnvelopeNotificationRequest.php index a415647b..e8d0c824 100644 --- a/src/Model/EnvelopeNotificationRequest.php +++ b/src/Model/EnvelopeNotificationRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/EnvelopeSummary.php b/src/Model/EnvelopeSummary.php index 387ec51d..2e630cde 100644 --- a/src/Model/EnvelopeSummary.php +++ b/src/Model/EnvelopeSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ class EnvelopeSummary implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'envelope_id' => 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 = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,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) { @@ -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 status + * * @return string */ public function getStatus() @@ -192,7 +258,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) @@ -204,6 +272,7 @@ public function setStatus($status) /** * Gets status_date_time + * * @return string */ public function getStatusDateTime() @@ -213,7 +282,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) @@ -225,6 +296,7 @@ public function setStatusDateTime($status_date_time) /** * Gets uri + * * @return string */ public function getUri() @@ -234,7 +306,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -245,7 +319,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) @@ -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/EnvelopeTemplate.php b/src/Model/EnvelopeTemplate.php index 77977313..cb4dec7c 100644 --- a/src/Model/EnvelopeTemplate.php +++ b/src/Model/EnvelopeTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -110,13 +113,92 @@ class EnvelopeTemplate implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_view_history' => 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' => 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_id' => null, + 'envelope_id_stamping' => null, + 'envelope_template_definition' => null, + 'envelope_uri' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => null, + 'lock_information' => null, + 'message_lock' => null, + 'notification' => null, + 'notification_uri' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sent_date_time' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_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 = [ @@ -176,9 +258,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -238,9 +320,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -300,34 +382,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) { @@ -388,30 +499,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_markup + * * @return string */ public function getAllowMarkup() @@ -421,7 +534,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) @@ -433,6 +548,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -442,7 +558,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) @@ -454,6 +572,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -463,7 +582,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -475,6 +596,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -484,7 +606,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) @@ -496,6 +620,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -505,7 +630,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -517,6 +644,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -526,7 +654,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) @@ -538,6 +668,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -547,7 +678,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -559,6 +692,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -568,7 +702,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -580,6 +716,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -589,7 +726,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id + * * @return $this */ public function setBrandId($brand_id) @@ -601,6 +740,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -610,7 +750,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -622,6 +764,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -631,7 +774,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) @@ -643,6 +788,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -652,7 +798,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) @@ -664,6 +812,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -673,7 +822,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -685,6 +836,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -694,7 +846,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) @@ -706,6 +860,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -715,7 +870,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) @@ -727,6 +884,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -736,7 +894,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) @@ -748,6 +908,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -757,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) @@ -769,6 +932,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -778,7 +942,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) @@ -790,6 +956,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -799,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) @@ -811,6 +980,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -820,7 +990,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -832,6 +1004,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -841,7 +1014,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) @@ -853,6 +1028,7 @@ public function setDocuments($documents) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -862,7 +1038,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -874,6 +1052,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -883,7 +1062,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) @@ -895,6 +1076,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -904,7 +1086,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -916,6 +1100,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -925,7 +1110,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) @@ -937,6 +1124,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -946,7 +1134,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) @@ -958,6 +1148,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -967,7 +1158,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) @@ -979,6 +1172,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -988,7 +1182,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) @@ -1000,6 +1196,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1009,7 +1206,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) @@ -1021,6 +1220,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1030,7 +1230,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) @@ -1042,6 +1244,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_template_definition + * * @return \DocuSign\eSign\Model\EnvelopeTemplateDefinition */ public function getEnvelopeTemplateDefinition() @@ -1051,7 +1254,9 @@ public function getEnvelopeTemplateDefinition() /** * Sets envelope_template_definition - * @param \DocuSign\eSign\Model\EnvelopeTemplateDefinition $envelope_template_definition + * + * @param \DocuSign\eSign\Model\EnvelopeTemplateDefinition $envelope_template_definition envelope_template_definition + * * @return $this */ public function setEnvelopeTemplateDefinition($envelope_template_definition) @@ -1063,6 +1268,7 @@ public function setEnvelopeTemplateDefinition($envelope_template_definition) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1072,7 +1278,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) @@ -1084,6 +1292,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1093,7 +1302,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1105,6 +1316,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1114,7 +1326,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) @@ -1126,6 +1340,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1135,7 +1350,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1147,6 +1364,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1156,7 +1374,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) @@ -1168,6 +1388,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1177,7 +1398,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) @@ -1189,6 +1412,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1198,7 +1422,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) @@ -1210,6 +1436,7 @@ public function setMessageLock($message_lock) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1219,7 +1446,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) @@ -1231,6 +1460,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1240,7 +1470,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) @@ -1252,6 +1484,7 @@ public function setNotificationUri($notification_uri) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1261,7 +1494,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -1273,6 +1508,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -1282,7 +1518,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) @@ -1294,6 +1532,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -1303,7 +1542,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) @@ -1315,6 +1556,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -1324,7 +1566,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) @@ -1336,6 +1580,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1345,7 +1590,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) @@ -1357,6 +1604,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -1366,7 +1614,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) @@ -1378,6 +1628,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -1387,7 +1638,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) @@ -1399,6 +1652,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -1408,7 +1662,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) @@ -1420,6 +1676,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -1429,7 +1686,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) @@ -1441,6 +1700,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -1450,7 +1710,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) @@ -1462,6 +1724,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -1471,7 +1734,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) @@ -1483,6 +1748,7 @@ public function setTransactionId($transaction_id) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -1492,7 +1758,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) @@ -1504,6 +1772,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -1513,7 +1782,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) @@ -1525,6 +1796,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -1534,7 +1806,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) @@ -1545,7 +1819,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) @@ -1555,7 +1831,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1565,8 +1843,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1580,7 +1860,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1590,16 +1872,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); } - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } - diff --git a/src/Model/EnvelopeTemplateDefinition.php b/src/Model/EnvelopeTemplateDefinition.php index 8841f55f..83b873f4 100644 --- a/src/Model/EnvelopeTemplateDefinition.php +++ b/src/Model/EnvelopeTemplateDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTemplateDefinition Class Doc Comment @@ -40,18 +41,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTemplateDefinition implements ArrayAccess +class EnvelopeTemplateDefinition implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTemplateDefinition'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -73,13 +76,54 @@ class EnvelopeTemplateDefinition implements ArrayAccess 'uri' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'created' => null, + 'description' => null, + 'folder_id' => null, + 'folder_name' => null, + 'folder_uri' => null, + 'last_modified' => null, + 'last_modified_by' => null, + 'name' => null, + 'new_password' => null, + 'owner' => null, + 'page_count' => 'int32', + 'parent_folder_uri' => null, + 'password' => null, + 'shared' => null, + 'template_id' => 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 = [ @@ -101,9 +145,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -125,9 +169,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -149,34 +193,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) { @@ -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 created + * * @return string */ public function getCreated() @@ -232,7 +307,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -244,6 +321,7 @@ public function setCreated($created) /** * Gets description + * * @return string */ public function getDescription() @@ -253,7 +331,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -265,6 +345,7 @@ public function setDescription($description) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -274,7 +355,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id The ID for the folder. + * * @return $this */ public function setFolderId($folder_id) @@ -286,6 +369,7 @@ public function setFolderId($folder_id) /** * Gets folder_name + * * @return string */ public function getFolderName() @@ -295,7 +379,9 @@ public function getFolderName() /** * Sets folder_name + * * @param string $folder_name The name of the folder in which the template is located. + * * @return $this */ public function setFolderName($folder_name) @@ -307,6 +393,7 @@ public function setFolderName($folder_name) /** * Gets folder_uri + * * @return string */ public function getFolderUri() @@ -316,7 +403,9 @@ public function getFolderUri() /** * Sets folder_uri + * * @param string $folder_uri The URI of the folder. + * * @return $this */ public function setFolderUri($folder_uri) @@ -328,6 +417,7 @@ public function setFolderUri($folder_uri) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -337,7 +427,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -349,6 +441,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by + * * @return \DocuSign\eSign\Model\UserInfo */ public function getLastModifiedBy() @@ -358,7 +451,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) @@ -370,6 +465,7 @@ public function setLastModifiedBy($last_modified_by) /** * Gets name + * * @return string */ public function getName() @@ -379,7 +475,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -391,6 +489,7 @@ public function setName($name) /** * Gets new_password + * * @return string */ public function getNewPassword() @@ -400,7 +499,9 @@ public function getNewPassword() /** * Sets new_password + * * @param string $new_password + * * @return $this */ public function setNewPassword($new_password) @@ -412,6 +513,7 @@ public function setNewPassword($new_password) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -421,7 +523,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) @@ -433,6 +537,7 @@ public function setOwner($owner) /** * Gets page_count + * * @return int */ public function getPageCount() @@ -442,7 +547,9 @@ public function getPageCount() /** * Sets page_count + * * @param int $page_count An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count. + * * @return $this */ public function setPageCount($page_count) @@ -454,6 +561,7 @@ public function setPageCount($page_count) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -463,7 +571,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -475,6 +585,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets password + * * @return string */ public function getPassword() @@ -484,7 +595,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -496,6 +609,7 @@ public function setPassword($password) /** * Gets shared + * * @return string */ public function getShared() @@ -505,7 +619,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -517,6 +633,7 @@ public function setShared($shared) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -526,7 +643,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) @@ -538,6 +657,7 @@ public function setTemplateId($template_id) /** * Gets uri + * * @return string */ public function getUri() @@ -547,7 +667,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -558,7 +680,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) @@ -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/EnvelopeTemplateResult.php b/src/Model/EnvelopeTemplateResult.php index b6ba933e..dac97629 100644 --- a/src/Model/EnvelopeTemplateResult.php +++ b/src/Model/EnvelopeTemplateResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * EnvelopeTemplateResult Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class EnvelopeTemplateResult implements ArrayAccess +class EnvelopeTemplateResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'envelopeTemplateResult'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -123,13 +126,105 @@ class EnvelopeTemplateResult implements ArrayAccess 'voided_reason' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_markup' => null, + 'allow_reassign' => null, + 'allow_view_history' => 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' => 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_id' => null, + 'envelope_id_stamping' => null, + 'envelope_uri' => null, + 'folder_id' => null, + 'folder_name' => null, + 'folder_uri' => null, + 'initial_sent_date_time' => null, + 'is21_cfr_part11' => null, + 'is_signature_provider_envelope' => null, + 'last_modified' => null, + 'last_modified_date_time' => null, + 'lock_information' => null, + 'message_lock' => null, + 'name' => null, + 'notification' => null, + 'notification_uri' => null, + 'owner' => null, + 'page_count' => 'int32', + 'parent_folder_uri' => null, + 'password' => null, + 'purge_state' => null, + 'recipients' => null, + 'recipients_lock' => null, + 'recipients_uri' => null, + 'sent_date_time' => null, + 'shared' => null, + 'signer_can_sign_on_mobile' => null, + 'signing_location' => null, + 'status' => null, + 'status_changed_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 = [ @@ -202,9 +297,9 @@ public static function swaggerTypes() 'voided_reason' => 'voidedReason' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -277,9 +372,9 @@ public static function swaggerTypes() 'voided_reason' => 'setVoidedReason' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -352,34 +447,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) { @@ -453,30 +577,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_markup + * * @return string */ public function getAllowMarkup() @@ -486,7 +612,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) @@ -498,6 +626,7 @@ public function setAllowMarkup($allow_markup) /** * Gets allow_reassign + * * @return string */ public function getAllowReassign() @@ -507,7 +636,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) @@ -519,6 +650,7 @@ public function setAllowReassign($allow_reassign) /** * Gets allow_view_history + * * @return string */ public function getAllowViewHistory() @@ -528,7 +660,9 @@ public function getAllowViewHistory() /** * Sets allow_view_history + * * @param string $allow_view_history + * * @return $this */ public function setAllowViewHistory($allow_view_history) @@ -540,6 +674,7 @@ public function setAllowViewHistory($allow_view_history) /** * Gets asynchronous + * * @return string */ public function getAsynchronous() @@ -549,7 +684,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) @@ -561,6 +698,7 @@ public function setAsynchronous($asynchronous) /** * Gets attachments_uri + * * @return string */ public function getAttachmentsUri() @@ -570,7 +708,9 @@ public function getAttachmentsUri() /** * Sets attachments_uri + * * @param string $attachments_uri + * * @return $this */ public function setAttachmentsUri($attachments_uri) @@ -582,6 +722,7 @@ public function setAttachmentsUri($attachments_uri) /** * Gets authoritative_copy + * * @return string */ public function getAuthoritativeCopy() @@ -591,7 +732,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) @@ -603,6 +746,7 @@ public function setAuthoritativeCopy($authoritative_copy) /** * Gets authoritative_copy_default + * * @return string */ public function getAuthoritativeCopyDefault() @@ -612,7 +756,9 @@ public function getAuthoritativeCopyDefault() /** * Sets authoritative_copy_default + * * @param string $authoritative_copy_default + * * @return $this */ public function setAuthoritativeCopyDefault($authoritative_copy_default) @@ -624,6 +770,7 @@ public function setAuthoritativeCopyDefault($authoritative_copy_default) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -633,7 +780,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -645,6 +794,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets brand_id + * * @return string */ public function getBrandId() @@ -654,7 +804,9 @@ public function getBrandId() /** * Sets brand_id + * * @param string $brand_id + * * @return $this */ public function setBrandId($brand_id) @@ -666,6 +818,7 @@ public function setBrandId($brand_id) /** * Gets brand_lock + * * @return string */ public function getBrandLock() @@ -675,7 +828,9 @@ public function getBrandLock() /** * Sets brand_lock + * * @param string $brand_lock + * * @return $this */ public function setBrandLock($brand_lock) @@ -687,6 +842,7 @@ public function setBrandLock($brand_lock) /** * Gets certificate_uri + * * @return string */ public function getCertificateUri() @@ -696,7 +852,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) @@ -708,6 +866,7 @@ public function setCertificateUri($certificate_uri) /** * Gets completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -717,7 +876,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) @@ -729,6 +890,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets copy_recipient_data + * * @return string */ public function getCopyRecipientData() @@ -738,7 +900,9 @@ public function getCopyRecipientData() /** * Sets copy_recipient_data + * * @param string $copy_recipient_data + * * @return $this */ public function setCopyRecipientData($copy_recipient_data) @@ -750,6 +914,7 @@ public function setCopyRecipientData($copy_recipient_data) /** * Gets created + * * @return string */ public function getCreated() @@ -759,7 +924,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -771,6 +938,7 @@ public function setCreated($created) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -780,7 +948,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) @@ -792,6 +962,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFields */ public function getCustomFields() @@ -801,7 +972,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) @@ -813,6 +986,7 @@ public function setCustomFields($custom_fields) /** * Gets custom_fields_uri + * * @return string */ public function getCustomFieldsUri() @@ -822,7 +996,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) @@ -834,6 +1010,7 @@ public function setCustomFieldsUri($custom_fields_uri) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -843,7 +1020,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) @@ -855,6 +1034,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets deleted_date_time + * * @return string */ public function getDeletedDateTime() @@ -864,7 +1044,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) @@ -876,6 +1058,7 @@ public function setDeletedDateTime($deleted_date_time) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -885,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) @@ -897,6 +1082,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets description + * * @return string */ public function getDescription() @@ -906,7 +1092,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -918,6 +1106,7 @@ public function setDescription($description) /** * Gets disable_responsive_document + * * @return string */ public function getDisableResponsiveDocument() @@ -927,7 +1116,9 @@ public function getDisableResponsiveDocument() /** * Sets disable_responsive_document + * * @param string $disable_responsive_document + * * @return $this */ public function setDisableResponsiveDocument($disable_responsive_document) @@ -939,6 +1130,7 @@ public function setDisableResponsiveDocument($disable_responsive_document) /** * Gets documents + * * @return \DocuSign\eSign\Model\Document[] */ public function getDocuments() @@ -948,7 +1140,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) @@ -960,6 +1154,7 @@ public function setDocuments($documents) /** * Gets documents_combined_uri + * * @return string */ public function getDocumentsCombinedUri() @@ -969,7 +1164,9 @@ public function getDocumentsCombinedUri() /** * Sets documents_combined_uri + * * @param string $documents_combined_uri + * * @return $this */ public function setDocumentsCombinedUri($documents_combined_uri) @@ -981,6 +1178,7 @@ public function setDocumentsCombinedUri($documents_combined_uri) /** * Gets documents_uri + * * @return string */ public function getDocumentsUri() @@ -990,7 +1188,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) @@ -1002,6 +1202,7 @@ public function setDocumentsUri($documents_uri) /** * Gets email_blurb + * * @return string */ public function getEmailBlurb() @@ -1011,7 +1212,9 @@ public function getEmailBlurb() /** * Sets email_blurb + * * @param string $email_blurb + * * @return $this */ public function setEmailBlurb($email_blurb) @@ -1023,6 +1226,7 @@ public function setEmailBlurb($email_blurb) /** * Gets email_settings + * * @return \DocuSign\eSign\Model\EmailSettings */ public function getEmailSettings() @@ -1032,7 +1236,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) @@ -1044,6 +1250,7 @@ public function setEmailSettings($email_settings) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -1053,7 +1260,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) @@ -1065,6 +1274,7 @@ public function setEmailSubject($email_subject) /** * Gets enable_wet_sign + * * @return string */ public function getEnableWetSign() @@ -1074,7 +1284,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) @@ -1086,6 +1298,7 @@ public function setEnableWetSign($enable_wet_sign) /** * Gets enforce_signer_visibility + * * @return string */ public function getEnforceSignerVisibility() @@ -1095,7 +1308,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) @@ -1107,6 +1322,7 @@ public function setEnforceSignerVisibility($enforce_signer_visibility) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -1116,7 +1332,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) @@ -1128,6 +1346,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_id_stamping + * * @return string */ public function getEnvelopeIdStamping() @@ -1137,7 +1356,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) @@ -1149,6 +1370,7 @@ public function setEnvelopeIdStamping($envelope_id_stamping) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -1158,7 +1380,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) @@ -1170,6 +1394,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -1179,7 +1404,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -1191,6 +1418,7 @@ public function setFolderId($folder_id) /** * Gets folder_name + * * @return string */ public function getFolderName() @@ -1200,7 +1428,9 @@ public function getFolderName() /** * Sets folder_name + * * @param string $folder_name + * * @return $this */ public function setFolderName($folder_name) @@ -1212,6 +1442,7 @@ public function setFolderName($folder_name) /** * Gets folder_uri + * * @return string */ public function getFolderUri() @@ -1221,7 +1452,9 @@ public function getFolderUri() /** * Sets folder_uri + * * @param string $folder_uri + * * @return $this */ public function setFolderUri($folder_uri) @@ -1233,6 +1466,7 @@ public function setFolderUri($folder_uri) /** * Gets initial_sent_date_time + * * @return string */ public function getInitialSentDateTime() @@ -1242,7 +1476,9 @@ public function getInitialSentDateTime() /** * Sets initial_sent_date_time + * * @param string $initial_sent_date_time + * * @return $this */ public function setInitialSentDateTime($initial_sent_date_time) @@ -1254,6 +1490,7 @@ public function setInitialSentDateTime($initial_sent_date_time) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -1263,7 +1500,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) @@ -1275,6 +1514,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -1284,7 +1524,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -1296,6 +1538,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -1305,7 +1548,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -1317,6 +1562,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -1326,7 +1572,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) @@ -1338,6 +1586,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -1347,7 +1596,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) @@ -1359,6 +1610,7 @@ public function setLockInformation($lock_information) /** * Gets message_lock + * * @return string */ public function getMessageLock() @@ -1368,7 +1620,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) @@ -1380,6 +1634,7 @@ public function setMessageLock($message_lock) /** * Gets name + * * @return string */ public function getName() @@ -1389,7 +1644,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1401,6 +1658,7 @@ public function setName($name) /** * Gets notification + * * @return \DocuSign\eSign\Model\Notification */ public function getNotification() @@ -1410,7 +1668,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) @@ -1422,6 +1682,7 @@ public function setNotification($notification) /** * Gets notification_uri + * * @return string */ public function getNotificationUri() @@ -1431,7 +1692,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) @@ -1443,6 +1706,7 @@ public function setNotificationUri($notification_uri) /** * Gets owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -1452,7 +1716,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) @@ -1464,6 +1730,7 @@ public function setOwner($owner) /** * Gets page_count + * * @return int */ public function getPageCount() @@ -1473,7 +1740,9 @@ public function getPageCount() /** * Sets page_count + * * @param int $page_count + * * @return $this */ public function setPageCount($page_count) @@ -1485,6 +1754,7 @@ public function setPageCount($page_count) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -1494,7 +1764,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -1506,6 +1778,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets password + * * @return string */ public function getPassword() @@ -1515,7 +1788,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -1527,6 +1802,7 @@ public function setPassword($password) /** * Gets purge_state + * * @return string */ public function getPurgeState() @@ -1536,7 +1812,9 @@ public function getPurgeState() /** * Sets purge_state + * * @param string $purge_state + * * @return $this */ public function setPurgeState($purge_state) @@ -1548,6 +1826,7 @@ public function setPurgeState($purge_state) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -1557,7 +1836,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) @@ -1569,6 +1850,7 @@ public function setRecipients($recipients) /** * Gets recipients_lock + * * @return string */ public function getRecipientsLock() @@ -1578,7 +1860,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) @@ -1590,6 +1874,7 @@ public function setRecipientsLock($recipients_lock) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -1599,7 +1884,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) @@ -1611,6 +1898,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1620,7 +1908,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) @@ -1632,6 +1922,7 @@ public function setSentDateTime($sent_date_time) /** * Gets shared + * * @return string */ public function getShared() @@ -1641,7 +1932,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1653,6 +1946,7 @@ public function setShared($shared) /** * Gets signer_can_sign_on_mobile + * * @return string */ public function getSignerCanSignOnMobile() @@ -1662,7 +1956,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) @@ -1674,6 +1970,7 @@ public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) /** * Gets signing_location + * * @return string */ public function getSigningLocation() @@ -1683,7 +1980,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) @@ -1695,6 +1994,7 @@ public function setSigningLocation($signing_location) /** * Gets status + * * @return string */ public function getStatus() @@ -1704,7 +2004,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) @@ -1716,6 +2018,7 @@ public function setStatus($status) /** * Gets status_changed_date_time + * * @return string */ public function getStatusChangedDateTime() @@ -1725,7 +2028,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) @@ -1737,6 +2042,7 @@ public function setStatusChangedDateTime($status_changed_date_time) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -1746,7 +2052,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) @@ -1758,6 +2066,7 @@ public function setTemplateId($template_id) /** * Gets templates_uri + * * @return string */ public function getTemplatesUri() @@ -1767,7 +2076,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) @@ -1779,6 +2090,7 @@ public function setTemplatesUri($templates_uri) /** * Gets transaction_id + * * @return string */ public function getTransactionId() @@ -1788,7 +2100,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) @@ -1800,6 +2114,7 @@ public function setTransactionId($transaction_id) /** * Gets uri + * * @return string */ public function getUri() @@ -1809,7 +2124,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -1821,6 +2138,7 @@ public function setUri($uri) /** * Gets use_disclosure + * * @return string */ public function getUseDisclosure() @@ -1830,7 +2148,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) @@ -1842,6 +2162,7 @@ public function setUseDisclosure($use_disclosure) /** * Gets voided_date_time + * * @return string */ public function getVoidedDateTime() @@ -1851,7 +2172,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) @@ -1863,6 +2186,7 @@ public function setVoidedDateTime($voided_date_time) /** * Gets voided_reason + * * @return string */ public function getVoidedReason() @@ -1872,7 +2196,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) @@ -1883,7 +2209,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) @@ -1893,7 +2221,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1903,8 +2233,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param 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 +2250,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1928,16 +2262,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 da155fe6..f77f7d7a 100644 --- a/src/Model/EnvelopeTemplateResults.php +++ b/src/Model/EnvelopeTemplateResults.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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\EnvelopeTemplateResult[] */ public function getEnvelopeTemplates() @@ -212,7 +282,9 @@ public function getEnvelopeTemplates() /** * Sets envelope_templates + * * @param \DocuSign\eSign\Model\EnvelopeTemplateResult[] $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 a97ab653..8434e2f4 100644 --- a/src/Model/EnvelopeTransactionStatus.php +++ b/src/Model/EnvelopeTransactionStatus.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/EnvelopeUpdateSummary.php b/src/Model/EnvelopeUpdateSummary.php index b41f2b13..b4a1d95e 100644 --- a/src/Model/EnvelopeUpdateSummary.php +++ b/src/Model/EnvelopeUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -64,13 +67,46 @@ 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, + '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 = [ @@ -84,9 +120,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 = [ @@ -100,9 +136,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 = [ @@ -116,34 +152,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) { @@ -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 bulk_envelope_status + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus */ public function getBulkEnvelopeStatus() @@ -191,7 +258,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) @@ -203,6 +272,7 @@ public function setBulkEnvelopeStatus($bulk_envelope_status) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -212,7 +282,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) @@ -224,6 +296,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -233,7 +306,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) @@ -245,6 +320,7 @@ public function setErrorDetails($error_details) /** * Gets list_custom_field_update_results + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFieldUpdateResults() @@ -254,7 +330,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) @@ -266,6 +344,7 @@ public function setListCustomFieldUpdateResults($list_custom_field_update_result /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -275,7 +354,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) @@ -287,6 +368,7 @@ public function setLockInformation($lock_information) /** * Gets recipient_update_results + * * @return \DocuSign\eSign\Model\RecipientUpdateResponse[] */ public function getRecipientUpdateResults() @@ -296,7 +378,9 @@ public function getRecipientUpdateResults() /** * Sets recipient_update_results + * * @param \DocuSign\eSign\Model\RecipientUpdateResponse[] $recipient_update_results + * * @return $this */ public function setRecipientUpdateResults($recipient_update_results) @@ -308,6 +392,7 @@ public function setRecipientUpdateResults($recipient_update_results) /** * Gets tab_update_results + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabUpdateResults() @@ -317,7 +402,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) @@ -329,6 +416,7 @@ public function setTabUpdateResults($tab_update_results) /** * Gets text_custom_field_update_results + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFieldUpdateResults() @@ -338,7 +426,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) @@ -349,7 +439,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) @@ -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/EnvelopesInformation.php b/src/Model/EnvelopesInformation.php index eb172fd5..2111780b 100644 --- a/src/Model/EnvelopesInformation.php +++ b/src/Model/EnvelopesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -66,13 +69,48 @@ 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, + '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 = [ @@ -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 continuation_token + * * @return string */ public function getContinuationToken() @@ -201,7 +270,9 @@ public function getContinuationToken() /** * Sets continuation_token + * * @param string $continuation_token + * * @return $this */ public function setContinuationToken($continuation_token) @@ -213,6 +284,7 @@ public function setContinuationToken($continuation_token) /** * Gets end_position + * * @return string */ public function getEndPosition() @@ -222,7 +294,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) @@ -234,6 +308,7 @@ public function setEndPosition($end_position) /** * Gets envelopes + * * @return \DocuSign\eSign\Model\Envelope[] */ public function getEnvelopes() @@ -243,7 +318,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\Envelope[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -255,6 +332,7 @@ public function setEnvelopes($envelopes) /** * Gets envelope_transaction_statuses + * * @return \DocuSign\eSign\Model\EnvelopeTransactionStatus[] */ public function getEnvelopeTransactionStatuses() @@ -264,7 +342,9 @@ public function getEnvelopeTransactionStatuses() /** * Sets envelope_transaction_statuses + * * @param \DocuSign\eSign\Model\EnvelopeTransactionStatus[] $envelope_transaction_statuses + * * @return $this */ public function setEnvelopeTransactionStatuses($envelope_transaction_statuses) @@ -276,6 +356,7 @@ public function setEnvelopeTransactionStatuses($envelope_transaction_statuses) /** * Gets last_queried_date_time + * * @return string */ public function getLastQueriedDateTime() @@ -285,7 +366,9 @@ public function getLastQueriedDateTime() /** * Sets last_queried_date_time + * * @param string $last_queried_date_time + * * @return $this */ public function setLastQueriedDateTime($last_queried_date_time) @@ -297,6 +380,7 @@ public function setLastQueriedDateTime($last_queried_date_time) /** * 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/ErrorDetails.php b/src/Model/ErrorDetails.php index bbc1738e..006abe0a 100644 --- a/src/Model/ErrorDetails.php +++ b/src/Model/ErrorDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 49880d0d..b8772443 100644 --- a/src/Model/EventNotification.php +++ b/src/Model/EventNotification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -73,13 +76,54 @@ 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, + '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 = [ @@ -101,9 +145,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'useSoapInterface' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -125,9 +169,9 @@ public static function swaggerTypes() 'use_soap_interface' => 'setUseSoapInterface' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -149,34 +193,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) { @@ -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 envelope_events + * * @return \DocuSign\eSign\Model\EnvelopeEvent[] */ public function getEnvelopeEvents() @@ -232,7 +307,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) @@ -244,6 +321,7 @@ public function setEnvelopeEvents($envelope_events) /** * Gets include_certificate_of_completion + * * @return string */ public function getIncludeCertificateOfCompletion() @@ -253,7 +331,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) @@ -265,6 +345,7 @@ public function setIncludeCertificateOfCompletion($include_certificate_of_comple /** * Gets include_certificate_with_soap + * * @return string */ public function getIncludeCertificateWithSoap() @@ -274,7 +355,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) @@ -286,6 +369,7 @@ public function setIncludeCertificateWithSoap($include_certificate_with_soap) /** * Gets include_document_fields + * * @return string */ public function getIncludeDocumentFields() @@ -295,7 +379,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) @@ -307,6 +393,7 @@ public function setIncludeDocumentFields($include_document_fields) /** * Gets include_documents + * * @return string */ public function getIncludeDocuments() @@ -316,7 +403,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) @@ -328,6 +417,7 @@ public function setIncludeDocuments($include_documents) /** * Gets include_envelope_void_reason + * * @return string */ public function getIncludeEnvelopeVoidReason() @@ -337,7 +427,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) @@ -349,6 +441,7 @@ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) /** * Gets include_hmac + * * @return string */ public function getIncludeHmac() @@ -358,7 +451,9 @@ public function getIncludeHmac() /** * Sets include_hmac + * * @param string $include_hmac + * * @return $this */ public function setIncludeHmac($include_hmac) @@ -370,6 +465,7 @@ public function setIncludeHmac($include_hmac) /** * Gets include_sender_account_as_custom_field + * * @return string */ public function getIncludeSenderAccountAsCustomField() @@ -379,7 +475,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) @@ -391,6 +489,7 @@ public function setIncludeSenderAccountAsCustomField($include_sender_account_as_ /** * Gets include_time_zone + * * @return string */ public function getIncludeTimeZone() @@ -400,7 +499,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) @@ -412,6 +513,7 @@ public function setIncludeTimeZone($include_time_zone) /** * Gets logging_enabled + * * @return string */ public function getLoggingEnabled() @@ -421,7 +523,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) @@ -433,6 +537,7 @@ public function setLoggingEnabled($logging_enabled) /** * Gets recipient_events + * * @return \DocuSign\eSign\Model\RecipientEvent[] */ public function getRecipientEvents() @@ -442,7 +547,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) @@ -454,6 +561,7 @@ public function setRecipientEvents($recipient_events) /** * Gets require_acknowledgment + * * @return string */ public function getRequireAcknowledgment() @@ -463,7 +571,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) @@ -475,6 +585,7 @@ public function setRequireAcknowledgment($require_acknowledgment) /** * Gets sign_message_with_x509_cert + * * @return string */ public function getSignMessageWithX509Cert() @@ -484,7 +595,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) @@ -496,6 +609,7 @@ public function setSignMessageWithX509Cert($sign_message_with_x509_cert) /** * Gets soap_name_space + * * @return string */ public function getSoapNameSpace() @@ -505,7 +619,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) @@ -517,6 +633,7 @@ public function setSoapNameSpace($soap_name_space) /** * Gets url + * * @return string */ public function getUrl() @@ -526,7 +643,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) @@ -538,6 +657,7 @@ public function setUrl($url) /** * Gets use_soap_interface + * * @return string */ public function getUseSoapInterface() @@ -547,7 +667,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) @@ -558,7 +680,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) @@ -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/EventResult.php b/src/Model/EventResult.php index 77181ba4..730b362b 100644 --- a/src/Model/EventResult.php +++ b/src/Model/EventResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a47be233..a233928b 100644 --- a/src/Model/Expirations.php +++ b/src/Model/Expirations.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5e8a70d3..9ec84b7a 100644 --- a/src/Model/ExternalDocServiceErrorDetails.php +++ b/src/Model/ExternalDocServiceErrorDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/ExternalFile.php b/src/Model/ExternalFile.php index 0a319c28..f4ec85fd 100644 --- a/src/Model/ExternalFile.php +++ b/src/Model/ExternalFile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9f7a79ed..79371053 100644 --- a/src/Model/ExternalFolder.php +++ b/src/Model/ExternalFolder.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/FeatureSet.php b/src/Model/FeatureSet.php index 3e4c692f..77a43de4 100644 --- a/src/Model/FeatureSet.php +++ b/src/Model/FeatureSet.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a06791c8..f107841b 100644 --- a/src/Model/FileType.php +++ b/src/Model/FileType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 954ea333..6ee5c49b 100644 --- a/src/Model/FileTypeList.php +++ b/src/Model/FileTypeList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 55fee2ee..d5fa02af 100644 --- a/src/Model/Filter.php +++ b/src/Model/Filter.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 db2ae4b2..1b126a85 100644 --- a/src/Model/FirstName.php +++ b/src/Model/FirstName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -90,13 +93,72 @@ class FirstName implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => 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 = [ @@ -136,9 +198,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -178,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -220,34 +282,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) { @@ -288,30 +379,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -321,7 +414,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) @@ -333,6 +428,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -342,7 +438,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) @@ -354,6 +452,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -363,7 +462,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) @@ -375,6 +476,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -384,7 +486,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) @@ -396,6 +500,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -405,7 +510,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) @@ -417,6 +524,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -426,7 +534,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) @@ -438,6 +548,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -447,7 +558,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) @@ -459,6 +572,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -468,7 +582,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) @@ -480,6 +596,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -489,7 +606,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) @@ -501,6 +620,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -510,7 +630,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) @@ -522,6 +644,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -531,7 +654,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) @@ -543,6 +668,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -552,7 +678,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) @@ -564,6 +692,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -573,7 +702,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) @@ -585,6 +716,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -594,7 +726,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) @@ -606,6 +740,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -615,7 +750,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) @@ -627,6 +764,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -636,7 +774,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) @@ -648,6 +788,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -657,7 +798,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) @@ -669,6 +812,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -678,7 +822,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) @@ -690,6 +836,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -699,7 +846,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) @@ -711,6 +860,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -720,7 +870,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -732,6 +884,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -741,7 +894,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) @@ -753,6 +908,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -762,7 +918,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) @@ -774,6 +932,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -783,7 +942,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) @@ -795,6 +956,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -804,7 +966,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -816,6 +980,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -825,7 +990,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) @@ -837,6 +1004,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -846,7 +1014,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) @@ -858,6 +1028,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -867,7 +1038,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -879,6 +1052,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -888,7 +1062,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) @@ -900,6 +1076,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -909,7 +1086,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) @@ -921,6 +1100,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -930,7 +1110,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -942,6 +1124,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -951,7 +1134,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) @@ -963,6 +1148,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -972,7 +1158,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -984,6 +1172,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -993,7 +1182,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) @@ -1005,6 +1196,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1014,7 +1206,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) @@ -1025,7 +1219,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) @@ -1035,7 +1231,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1045,8 +1243,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1060,7 +1260,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1070,16 +1272,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 19afd88c..1864adb3 100644 --- a/src/Model/Folder.php +++ b/src/Model/Folder.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -68,13 +71,50 @@ 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, + 'folders' => null, + 'name' => null, + 'owner_email' => null, + 'owner_user_id' => null, + 'owner_user_name' => null, + 'parent_folder_id' => null, + 'parent_folder_uri' => 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 = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,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) { @@ -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 error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -211,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) @@ -223,6 +296,7 @@ public function setErrorDetails($error_details) /** * Gets filter + * * @return \DocuSign\eSign\Model\Filter */ public function getFilter() @@ -232,7 +306,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) @@ -244,6 +320,7 @@ public function setFilter($filter) /** * Gets folder_id + * * @return string */ public function getFolderId() @@ -253,7 +330,9 @@ public function getFolderId() /** * Sets folder_id + * * @param string $folder_id + * * @return $this */ public function setFolderId($folder_id) @@ -265,6 +344,7 @@ public function setFolderId($folder_id) /** * Gets folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -274,7 +354,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) @@ -286,6 +368,7 @@ public function setFolders($folders) /** * Gets name + * * @return string */ public function getName() @@ -295,7 +378,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -307,6 +392,7 @@ public function setName($name) /** * Gets owner_email + * * @return string */ public function getOwnerEmail() @@ -316,7 +402,9 @@ public function getOwnerEmail() /** * Sets owner_email + * * @param string $owner_email + * * @return $this */ public function setOwnerEmail($owner_email) @@ -328,6 +416,7 @@ public function setOwnerEmail($owner_email) /** * Gets owner_user_id + * * @return string */ public function getOwnerUserId() @@ -337,7 +426,9 @@ public function getOwnerUserId() /** * Sets owner_user_id + * * @param string $owner_user_id + * * @return $this */ public function setOwnerUserId($owner_user_id) @@ -349,6 +440,7 @@ public function setOwnerUserId($owner_user_id) /** * Gets owner_user_name + * * @return string */ public function getOwnerUserName() @@ -358,7 +450,9 @@ public function getOwnerUserName() /** * Sets owner_user_name + * * @param string $owner_user_name + * * @return $this */ public function setOwnerUserName($owner_user_name) @@ -370,6 +464,7 @@ public function setOwnerUserName($owner_user_name) /** * Gets parent_folder_id + * * @return string */ public function getParentFolderId() @@ -379,7 +474,9 @@ public function getParentFolderId() /** * Sets parent_folder_id + * * @param string $parent_folder_id + * * @return $this */ public function setParentFolderId($parent_folder_id) @@ -391,6 +488,7 @@ public function setParentFolderId($parent_folder_id) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -400,7 +498,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -412,6 +512,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets type + * * @return string */ public function getType() @@ -421,7 +522,9 @@ public function getType() /** * Sets type + * * @param string $type + * * @return $this */ public function setType($type) @@ -433,6 +536,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -442,7 +546,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -453,7 +559,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) @@ -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/FolderItem.php b/src/Model/FolderItem.php index 61696ba5..e971a708 100644 --- a/src/Model/FolderItem.php +++ b/src/Model/FolderItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * FolderItem Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class FolderItem implements ArrayAccess +class FolderItem implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'folderItem'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -77,13 +80,59 @@ class FolderItem implements ArrayAccess '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, + 'custom_fields' => null, + 'description' => null, + 'envelope_id' => null, + 'envelope_uri' => null, + 'is21_cfr_part11' => null, + 'is_signature_provider_envelope' => null, + 'last_modified' => null, + 'name' => null, + 'owner_name' => null, + 'page_count' => 'int32', + 'password' => null, + 'sender_email' => null, + 'sender_name' => null, + 'sent_date_time' => null, + 'shared' => null, + 'status' => null, + 'subject' => null, + 'template_id' => 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 = [ @@ -110,9 +159,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -139,9 +188,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -168,34 +217,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) { @@ -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 completed_date_time + * * @return string */ public function getCompletedDateTime() @@ -256,7 +336,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) @@ -268,6 +350,7 @@ public function setCompletedDateTime($completed_date_time) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -277,7 +360,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) @@ -289,6 +374,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_fields + * * @return \DocuSign\eSign\Model\CustomFieldV2[] */ public function getCustomFields() @@ -298,7 +384,9 @@ public function getCustomFields() /** * Sets custom_fields + * * @param \DocuSign\eSign\Model\CustomFieldV2[] $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) @@ -310,6 +398,7 @@ public function setCustomFields($custom_fields) /** * Gets description + * * @return string */ public function getDescription() @@ -319,7 +408,9 @@ public function getDescription() /** * Sets description + * * @param string $description + * * @return $this */ public function setDescription($description) @@ -331,6 +422,7 @@ public function setDescription($description) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -340,7 +432,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) @@ -352,6 +446,7 @@ public function setEnvelopeId($envelope_id) /** * Gets envelope_uri + * * @return string */ public function getEnvelopeUri() @@ -361,7 +456,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) @@ -373,6 +470,7 @@ public function setEnvelopeUri($envelope_uri) /** * Gets is21_cfr_part11 + * * @return string */ public function getIs21CfrPart11() @@ -382,7 +480,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) @@ -394,6 +494,7 @@ public function setIs21CfrPart11($is21_cfr_part11) /** * Gets is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -403,7 +504,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -415,6 +518,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -424,7 +528,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -436,6 +542,7 @@ public function setLastModified($last_modified) /** * Gets name + * * @return string */ public function getName() @@ -445,7 +552,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -457,6 +566,7 @@ public function setName($name) /** * Gets owner_name + * * @return string */ public function getOwnerName() @@ -466,7 +576,9 @@ public function getOwnerName() /** * Sets owner_name + * * @param string $owner_name Name of the envelope owner. + * * @return $this */ public function setOwnerName($owner_name) @@ -478,6 +590,7 @@ public function setOwnerName($owner_name) /** * Gets page_count + * * @return int */ public function getPageCount() @@ -487,7 +600,9 @@ public function getPageCount() /** * Sets page_count + * * @param int $page_count + * * @return $this */ public function setPageCount($page_count) @@ -499,6 +614,7 @@ public function setPageCount($page_count) /** * Gets password + * * @return string */ public function getPassword() @@ -508,7 +624,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -520,6 +638,7 @@ public function setPassword($password) /** * Gets sender_email + * * @return string */ public function getSenderEmail() @@ -529,7 +648,9 @@ public function getSenderEmail() /** * Sets sender_email + * * @param string $sender_email + * * @return $this */ public function setSenderEmail($sender_email) @@ -541,6 +662,7 @@ public function setSenderEmail($sender_email) /** * Gets sender_name + * * @return string */ public function getSenderName() @@ -550,7 +672,9 @@ public function getSenderName() /** * Sets sender_name + * * @param string $sender_name Name of the envelope sender. + * * @return $this */ public function setSenderName($sender_name) @@ -562,6 +686,7 @@ public function setSenderName($sender_name) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -571,7 +696,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) @@ -583,6 +710,7 @@ public function setSentDateTime($sent_date_time) /** * Gets shared + * * @return string */ public function getShared() @@ -592,7 +720,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -604,6 +734,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -613,7 +744,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) @@ -625,6 +758,7 @@ public function setStatus($status) /** * Gets subject + * * @return string */ public function getSubject() @@ -634,7 +768,9 @@ public function getSubject() /** * Sets subject + * * @param string $subject + * * @return $this */ public function setSubject($subject) @@ -646,6 +782,7 @@ public function setSubject($subject) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -655,7 +792,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) @@ -667,6 +806,7 @@ public function setTemplateId($template_id) /** * Gets uri + * * @return string */ public function getUri() @@ -676,7 +816,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -687,7 +829,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) @@ -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/FolderItemResponse.php b/src/Model/FolderItemResponse.php index fe20e8e5..de849ef9 100644 --- a/src/Model/FolderItemResponse.php +++ b/src/Model/FolderItemResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b56e3fd0..8a744558 100644 --- a/src/Model/FolderItemV2.php +++ b/src/Model/FolderItemV2.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 'subject' => '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, + 'is_signature_provider_envelope' => null, + 'last_modified_date_time' => 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 + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'subject' => 'subject' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -136,9 +184,9 @@ public static function swaggerTypes() 'subject' => 'setSubject' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -164,34 +212,63 @@ public static function swaggerTypes() 'subject' => 'getSubject' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 is_signature_provider_envelope + * * @return string */ public function getIsSignatureProviderEnvelope() @@ -419,7 +522,9 @@ public function getIsSignatureProviderEnvelope() /** * Sets is_signature_provider_envelope + * * @param string $is_signature_provider_envelope + * * @return $this */ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) @@ -431,6 +536,7 @@ public function setIsSignatureProviderEnvelope($is_signature_provider_envelope) /** * Gets last_modified_date_time + * * @return string */ public function getLastModifiedDateTime() @@ -440,7 +546,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) @@ -452,6 +560,7 @@ public function setLastModifiedDateTime($last_modified_date_time) /** * Gets owner_name + * * @return string */ public function getOwnerName() @@ -461,7 +570,9 @@ public function getOwnerName() /** * Sets owner_name + * * @param string $owner_name + * * @return $this */ public function setOwnerName($owner_name) @@ -473,6 +584,7 @@ public function setOwnerName($owner_name) /** * Gets recipients + * * @return \DocuSign\eSign\Model\Recipients */ public function getRecipients() @@ -482,7 +594,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) @@ -494,6 +608,7 @@ public function setRecipients($recipients) /** * Gets recipients_uri + * * @return string */ public function getRecipientsUri() @@ -503,7 +618,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) @@ -515,6 +632,7 @@ public function setRecipientsUri($recipients_uri) /** * Gets sender_company + * * @return string */ public function getSenderCompany() @@ -524,7 +642,9 @@ public function getSenderCompany() /** * Sets sender_company + * * @param string $sender_company + * * @return $this */ public function setSenderCompany($sender_company) @@ -536,6 +656,7 @@ public function setSenderCompany($sender_company) /** * Gets sender_email + * * @return string */ public function getSenderEmail() @@ -545,7 +666,9 @@ public function getSenderEmail() /** * Sets sender_email + * * @param string $sender_email + * * @return $this */ public function setSenderEmail($sender_email) @@ -557,6 +680,7 @@ public function setSenderEmail($sender_email) /** * Gets sender_name + * * @return string */ public function getSenderName() @@ -566,7 +690,9 @@ public function getSenderName() /** * Sets sender_name + * * @param string $sender_name + * * @return $this */ public function setSenderName($sender_name) @@ -578,6 +704,7 @@ public function setSenderName($sender_name) /** * Gets sender_user_id + * * @return string */ public function getSenderUserId() @@ -587,7 +714,9 @@ public function getSenderUserId() /** * Sets sender_user_id + * * @param string $sender_user_id + * * @return $this */ public function setSenderUserId($sender_user_id) @@ -599,6 +728,7 @@ public function setSenderUserId($sender_user_id) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -608,7 +738,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) @@ -620,6 +752,7 @@ public function setSentDateTime($sent_date_time) /** * Gets status + * * @return string */ public function getStatus() @@ -629,7 +762,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) @@ -641,6 +776,7 @@ public function setStatus($status) /** * Gets subject + * * @return string */ public function getSubject() @@ -650,7 +786,9 @@ public function getSubject() /** * Sets subject + * * @param string $subject + * * @return $this */ public function setSubject($subject) @@ -661,7 +799,9 @@ public function setSubject($subject) } /** * 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 9a7e5020..deacd568 100644 --- a/src/Model/FolderItemsResponse.php +++ b/src/Model/FolderItemsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -63,13 +66,45 @@ 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, + 'folder_items' => 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 folder_items + * * @return \DocuSign\eSign\Model\FolderItem[] */ public function getFolderItems() @@ -207,7 +276,9 @@ public function getFolderItems() /** * Sets folder_items + * * @param \DocuSign\eSign\Model\FolderItem[] $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_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/FoldersRequest.php b/src/Model/FoldersRequest.php index 37c88233..babc75ae 100644 --- a/src/Model/FoldersRequest.php +++ b/src/Model/FoldersRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -58,13 +61,40 @@ 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, + '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 = [ @@ -72,9 +102,9 @@ public static function swaggerTypes() 'from_folder_id' => 'fromFolderId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -82,9 +112,9 @@ public static function swaggerTypes() 'from_folder_id' => 'setFromFolderId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -92,34 +122,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) { @@ -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 from_folder_id + * * @return string */ public function getFromFolderId() @@ -182,7 +246,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) @@ -193,7 +259,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) @@ -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/FoldersResponse.php b/src/Model/FoldersResponse.php index f98c5c09..85ad9098 100644 --- a/src/Model/FoldersResponse.php +++ b/src/Model/FoldersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,83 +40,140 @@ * @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 = [ 'folders' => '\DocuSign\eSign\Model\Folder[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'folders' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'folders' => 'folders' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'folders' => 'setFolders' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'folders' => 'getFolders' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 folders + * * @return \DocuSign\eSign\Model\Folder[] */ public function getFolders() @@ -156,7 +216,9 @@ public function getFolders() /** * Sets folders + * * @param \DocuSign\eSign\Model\Folder[] $folders + * * @return $this */ public function setFolders($folders) @@ -167,7 +229,9 @@ public function setFolders($folders) } /** * 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/ForgottenPasswordInformation.php b/src/Model/ForgottenPasswordInformation.php index 325c3bd2..69b944ed 100644 --- a/src/Model/ForgottenPasswordInformation.php +++ b/src/Model/ForgottenPasswordInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/FormulaTab.php b/src/Model/FormulaTab.php index 739e36e0..cdfaab0a 100644 --- a/src/Model/FormulaTab.php +++ b/src/Model/FormulaTab.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -108,13 +111,90 @@ class FormulaTab implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'formula' => null, + 'hidden' => null, + 'is_payment_amount' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'payment_details' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'round_decimal_places' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -172,9 +252,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -232,9 +312,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -292,34 +372,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) { @@ -378,30 +487,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -411,7 +522,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) @@ -423,6 +536,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -432,7 +546,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) @@ -444,6 +560,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -453,7 +570,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) @@ -465,6 +584,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -474,7 +594,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) @@ -486,6 +608,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -495,7 +618,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) @@ -507,6 +632,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -516,7 +642,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) @@ -528,6 +656,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -537,7 +666,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) @@ -549,6 +680,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -558,7 +690,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) @@ -570,6 +704,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -579,7 +714,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) @@ -591,6 +728,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -600,7 +738,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) @@ -612,6 +752,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -621,7 +762,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) @@ -633,6 +776,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -642,7 +786,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) @@ -654,6 +800,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -663,7 +810,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) @@ -675,6 +824,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -684,7 +834,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) @@ -696,6 +848,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -705,7 +858,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) @@ -717,6 +872,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -726,7 +882,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) @@ -738,6 +896,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -747,7 +906,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) @@ -759,6 +920,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -768,7 +930,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) @@ -780,6 +944,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -789,7 +954,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) @@ -801,6 +968,7 @@ public function setFontSize($font_size) /** * Gets formula + * * @return string */ public function getFormula() @@ -810,7 +978,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) @@ -822,6 +992,7 @@ public function setFormula($formula) /** * Gets hidden + * * @return string */ public function getHidden() @@ -831,7 +1002,9 @@ public function getHidden() /** * Sets hidden + * * @param string $hidden + * * @return $this */ public function setHidden($hidden) @@ -843,6 +1016,7 @@ public function setHidden($hidden) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -852,7 +1026,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) @@ -864,6 +1040,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets italic + * * @return string */ public function getItalic() @@ -873,7 +1050,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) @@ -885,6 +1064,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -894,7 +1074,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) @@ -906,6 +1088,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -915,7 +1098,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -927,6 +1112,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -936,7 +1122,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) @@ -948,6 +1136,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -957,7 +1146,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -969,6 +1160,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -978,7 +1170,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) @@ -990,6 +1184,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -999,7 +1194,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) @@ -1011,6 +1208,7 @@ public function setPageNumber($page_number) /** * Gets payment_details + * * @return \DocuSign\eSign\Model\PaymentDetails */ public function getPaymentDetails() @@ -1020,7 +1218,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) @@ -1032,6 +1232,7 @@ public function setPaymentDetails($payment_details) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1041,7 +1242,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) @@ -1053,6 +1256,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -1062,7 +1266,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) @@ -1074,6 +1280,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -1083,7 +1290,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) @@ -1095,6 +1304,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -1104,7 +1314,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) @@ -1116,6 +1328,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets round_decimal_places + * * @return string */ public function getRoundDecimalPlaces() @@ -1125,7 +1338,9 @@ public function getRoundDecimalPlaces() /** * Sets round_decimal_places + * * @param string $round_decimal_places + * * @return $this */ public function setRoundDecimalPlaces($round_decimal_places) @@ -1137,6 +1352,7 @@ public function setRoundDecimalPlaces($round_decimal_places) /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1146,7 +1362,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) @@ -1158,6 +1376,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1167,7 +1386,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1179,6 +1400,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1188,7 +1410,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) @@ -1200,6 +1424,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1209,7 +1434,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1221,6 +1448,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1230,7 +1458,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) @@ -1242,6 +1472,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1251,7 +1482,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) @@ -1263,6 +1496,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1272,7 +1506,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1284,6 +1520,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1293,7 +1530,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) @@ -1305,6 +1544,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1314,7 +1554,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) @@ -1326,6 +1568,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1335,7 +1578,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1347,6 +1592,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1356,7 +1602,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) @@ -1368,6 +1616,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1377,7 +1626,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) @@ -1389,6 +1640,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1398,7 +1650,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) @@ -1410,6 +1664,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1419,7 +1674,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1431,6 +1688,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1440,7 +1698,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1452,6 +1712,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1461,7 +1722,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) @@ -1473,6 +1736,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1482,7 +1746,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) @@ -1493,7 +1759,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) @@ -1503,7 +1771,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1513,8 +1783,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1528,7 +1800,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1538,16 +1812,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 94d80e1d..6b45cc8d 100644 --- a/src/Model/FullName.php +++ b/src/Model/FullName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -90,13 +93,72 @@ class FullName implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => 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 = [ @@ -136,9 +198,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -178,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -220,34 +282,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) { @@ -288,30 +379,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -321,7 +414,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) @@ -333,6 +428,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -342,7 +438,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) @@ -354,6 +452,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -363,7 +462,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) @@ -375,6 +476,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -384,7 +486,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) @@ -396,6 +500,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -405,7 +510,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) @@ -417,6 +524,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -426,7 +534,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) @@ -438,6 +548,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -447,7 +558,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) @@ -459,6 +572,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -468,7 +582,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) @@ -480,6 +596,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -489,7 +606,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) @@ -501,6 +620,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -510,7 +630,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) @@ -522,6 +644,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -531,7 +654,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) @@ -543,6 +668,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -552,7 +678,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) @@ -564,6 +692,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -573,7 +702,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) @@ -585,6 +716,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -594,7 +726,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) @@ -606,6 +740,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -615,7 +750,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) @@ -627,6 +764,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -636,7 +774,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) @@ -648,6 +788,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -657,7 +798,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) @@ -669,6 +812,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -678,7 +822,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) @@ -690,6 +836,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -699,7 +846,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) @@ -711,6 +860,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -720,7 +870,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -732,6 +884,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -741,7 +894,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) @@ -753,6 +908,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -762,7 +918,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) @@ -774,6 +932,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -783,7 +942,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) @@ -795,6 +956,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -804,7 +966,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -816,6 +980,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -825,7 +990,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) @@ -837,6 +1004,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -846,7 +1014,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) @@ -858,6 +1028,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -867,7 +1038,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -879,6 +1052,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -888,7 +1062,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) @@ -900,6 +1076,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -909,7 +1086,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) @@ -921,6 +1100,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -930,7 +1110,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -942,6 +1124,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -951,7 +1134,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) @@ -963,6 +1148,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -972,7 +1158,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -984,6 +1172,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -993,7 +1182,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) @@ -1005,6 +1196,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1014,7 +1206,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) @@ -1025,7 +1219,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) @@ -1035,7 +1231,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1045,8 +1243,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1060,7 +1260,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1070,16 +1272,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 35c1dc83..299ab08f 100644 --- a/src/Model/Group.php +++ b/src/Model/Group.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -62,13 +65,44 @@ class Group implements ArrayAccess 'users' => '\DocuSign\eSign\Model\UserInfo[]' ]; + /** + * 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 + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'users' => 'users' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -94,9 +128,9 @@ public static function swaggerTypes() 'users' => 'setUsers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -108,34 +142,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) { @@ -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 error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -181,7 +246,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) @@ -193,6 +260,7 @@ public function setErrorDetails($error_details) /** * Gets group_id + * * @return string */ public function getGroupId() @@ -202,7 +270,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) @@ -214,6 +284,7 @@ public function setGroupId($group_id) /** * Gets group_name + * * @return string */ public function getGroupName() @@ -223,7 +294,9 @@ public function getGroupName() /** * Sets group_name + * * @param string $group_name The name of the group. + * * @return $this */ public function setGroupName($group_name) @@ -235,6 +308,7 @@ public function setGroupName($group_name) /** * Gets group_type + * * @return string */ public function getGroupType() @@ -244,7 +318,9 @@ public function getGroupType() /** * Sets group_type + * * @param string $group_type The group type. + * * @return $this */ public function setGroupType($group_type) @@ -256,6 +332,7 @@ public function setGroupType($group_type) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -265,7 +342,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) @@ -277,6 +356,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getUsers() @@ -286,7 +366,9 @@ public function getUsers() /** * Sets users + * * @param \DocuSign\eSign\Model\UserInfo[] $users + * * @return $this */ public function setUsers($users) @@ -297,7 +379,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) @@ -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/GroupInformation.php b/src/Model/GroupInformation.php index f8698802..cb6e97ad 100644 --- a/src/Model/GroupInformation.php +++ b/src/Model/GroupInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/IdCheckInformationInput.php b/src/Model/IdCheckInformationInput.php index bd3a4c61..59cb9724 100644 --- a/src/Model/IdCheckInformationInput.php +++ b/src/Model/IdCheckInformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/InPersonSigner.php b/src/Model/InPersonSigner.php index 1b98cfe7..d6a06e75 100644 --- a/src/Model/InPersonSigner.php +++ b/src/Model/InPersonSigner.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -77,6 +80,7 @@ class InPersonSigner implements ArrayAccess 'host_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'in_person_signing_type' => 'string', 'name' => 'string', @@ -115,13 +119,98 @@ 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, + 'add_access_code_to_email' => null, + 'auto_navigation' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'host_email' => null, + 'host_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'in_person_signing_type' => null, + 'name' => null, + 'notary_host' => null, + 'note' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'require_id_lookup' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'signer_email' => null, + 'signer_name' => null, + 'sign_in_each_location' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -148,6 +237,7 @@ public static function swaggerTypes() 'host_name' => 'hostName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'in_person_signing_type' => 'inPersonSigningType', 'name' => 'name', @@ -186,9 +276,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -215,6 +305,7 @@ public static function swaggerTypes() 'host_name' => 'setHostName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'setInPersonSigningType', 'name' => 'setName', @@ -253,9 +344,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -282,6 +373,7 @@ public static function swaggerTypes() 'host_name' => 'getHostName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'getInPersonSigningType', 'name' => 'getName', @@ -320,34 +412,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) { @@ -374,6 +495,7 @@ public function __construct(array $data = null) $this->container['host_name'] = isset($data['host_name']) ? $data['host_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : null; @@ -413,30 +535,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -446,7 +570,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) @@ -458,6 +584,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -467,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) @@ -479,6 +608,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -488,7 +618,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -500,6 +632,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -509,7 +642,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) @@ -521,6 +656,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -530,7 +666,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) @@ -542,6 +680,7 @@ public function setClientUserId($client_user_id) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -551,7 +690,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -563,6 +704,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -572,7 +714,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) @@ -584,6 +728,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -593,7 +738,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) @@ -605,6 +752,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -614,7 +762,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) @@ -626,6 +776,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -635,7 +786,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -647,6 +800,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -656,7 +810,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) @@ -668,6 +824,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -677,7 +834,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -689,6 +848,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -698,7 +858,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -710,6 +872,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -719,7 +882,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -731,6 +896,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -740,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) @@ -752,6 +920,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -761,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) @@ -773,6 +944,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -782,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) @@ -794,6 +968,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -803,7 +978,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) @@ -815,6 +992,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -824,7 +1002,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -836,6 +1016,7 @@ public function setFaxNumber($fax_number) /** * Gets host_email + * * @return string */ public function getHostEmail() @@ -845,7 +1026,9 @@ public function getHostEmail() /** * Sets host_email + * * @param string $host_email + * * @return $this */ public function setHostEmail($host_email) @@ -857,6 +1040,7 @@ public function setHostEmail($host_email) /** * Gets host_name + * * @return string */ public function getHostName() @@ -866,7 +1050,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) @@ -878,6 +1064,7 @@ public function setHostName($host_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -887,7 +1074,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) @@ -899,6 +1088,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -908,7 +1098,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) @@ -918,8 +1110,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() @@ -929,7 +1146,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) @@ -941,6 +1160,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets in_person_signing_type + * * @return string */ public function getInPersonSigningType() @@ -950,7 +1170,9 @@ public function getInPersonSigningType() /** * Sets in_person_signing_type + * * @param string $in_person_signing_type + * * @return $this */ public function setInPersonSigningType($in_person_signing_type) @@ -962,6 +1184,7 @@ public function setInPersonSigningType($in_person_signing_type) /** * Gets name + * * @return string */ public function getName() @@ -971,7 +1194,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -983,6 +1208,7 @@ public function setName($name) /** * Gets notary_host + * * @return \DocuSign\eSign\Model\NotaryHost */ public function getNotaryHost() @@ -992,7 +1218,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) @@ -1004,6 +1232,7 @@ public function setNotaryHost($notary_host) /** * Gets note + * * @return string */ public function getNote() @@ -1013,7 +1242,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) @@ -1025,6 +1256,7 @@ public function setNote($note) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1034,7 +1266,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) @@ -1046,6 +1280,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1055,7 +1290,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) @@ -1067,6 +1304,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1076,7 +1314,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1088,6 +1328,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1097,7 +1338,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) @@ -1109,6 +1352,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1118,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) @@ -1130,6 +1376,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1139,7 +1386,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1151,6 +1400,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1160,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) @@ -1172,6 +1424,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1181,7 +1434,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1193,6 +1448,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1202,7 +1458,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) @@ -1214,6 +1472,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1223,7 +1482,9 @@ public function getRequireSignerCertificate() /** * Sets require_signer_certificate + * * @param string $require_signer_certificate + * * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) @@ -1235,6 +1496,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1244,7 +1506,9 @@ public function getRequireSignOnPaper() /** * Sets require_sign_on_paper + * * @param string $require_sign_on_paper + * * @return $this */ public function setRequireSignOnPaper($require_sign_on_paper) @@ -1256,6 +1520,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1265,7 +1530,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1277,6 +1544,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1286,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) @@ -1298,6 +1568,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1307,7 +1578,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1319,6 +1592,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1328,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) @@ -1340,6 +1616,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -1349,7 +1626,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) @@ -1361,6 +1640,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1370,7 +1650,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) @@ -1382,6 +1664,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signer_email + * * @return string */ public function getSignerEmail() @@ -1391,7 +1674,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) @@ -1403,6 +1688,7 @@ public function setSignerEmail($signer_email) /** * Gets signer_name + * * @return string */ public function getSignerName() @@ -1412,7 +1698,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) @@ -1424,6 +1712,7 @@ public function setSignerName($signer_name) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -1433,7 +1722,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) @@ -1445,6 +1736,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1454,7 +1746,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) @@ -1466,6 +1760,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1475,7 +1770,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) @@ -1487,6 +1784,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1496,7 +1794,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) @@ -1508,6 +1808,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1517,7 +1818,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) @@ -1529,6 +1832,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1538,7 +1842,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) @@ -1550,6 +1856,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1559,7 +1866,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) @@ -1571,6 +1880,7 @@ public function setStatus($status) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1580,7 +1890,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) @@ -1592,6 +1904,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1601,7 +1914,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) @@ -1613,6 +1928,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1622,7 +1938,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) @@ -1634,6 +1952,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1643,7 +1962,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1655,6 +1976,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1664,7 +1986,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1675,7 +1999,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) @@ -1685,7 +2011,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1695,8 +2023,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1710,7 +2040,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1720,16 +2052,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 d837536f..ef00e4d4 100644 --- a/src/Model/InitialHere.php +++ b/src/Model/InitialHere.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -85,13 +88,67 @@ class InitialHere implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'merge_field' => null, + 'name' => null, + 'optional' => null, + 'page_number' => null, + 'recipient_id' => null, + 'scale_value' => 'float', + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -126,9 +183,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -163,9 +220,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -200,34 +257,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) { @@ -263,30 +349,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -296,7 +384,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) @@ -308,6 +398,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -317,7 +408,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) @@ -329,6 +422,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -338,7 +432,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) @@ -350,6 +446,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -359,7 +456,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) @@ -371,6 +470,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -380,7 +480,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) @@ -392,6 +494,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -401,7 +504,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) @@ -413,6 +518,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -422,7 +528,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) @@ -434,6 +542,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -443,7 +552,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) @@ -455,6 +566,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -464,7 +576,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) @@ -476,6 +590,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -485,7 +600,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) @@ -497,6 +614,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -506,7 +624,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) @@ -518,6 +638,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -527,7 +648,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) @@ -539,6 +662,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -548,7 +672,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) @@ -560,6 +686,7 @@ public function setErrorDetails($error_details) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -569,7 +696,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) @@ -581,6 +710,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -590,7 +720,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -602,6 +734,7 @@ public function setName($name) /** * Gets optional + * * @return string */ public function getOptional() @@ -611,7 +744,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -623,6 +758,7 @@ public function setOptional($optional) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -632,7 +768,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) @@ -644,6 +782,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -653,7 +792,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) @@ -665,6 +806,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value + * * @return float */ public function getScaleValue() @@ -674,7 +816,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param float $scale_value Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. + * * @return $this */ public function setScaleValue($scale_value) @@ -686,6 +830,7 @@ public function setScaleValue($scale_value) /** * Gets status + * * @return string */ public function getStatus() @@ -695,7 +840,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) @@ -707,6 +854,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -716,7 +864,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -728,6 +878,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -737,7 +888,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) @@ -749,6 +902,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -758,7 +912,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) @@ -770,6 +926,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -779,7 +936,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -791,6 +950,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -800,7 +960,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) @@ -812,6 +974,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -821,7 +984,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) @@ -833,6 +998,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -842,7 +1008,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -854,6 +1022,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -863,7 +1032,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) @@ -875,6 +1046,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -884,7 +1056,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) @@ -895,7 +1069,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) @@ -905,7 +1081,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -915,8 +1093,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -930,7 +1110,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -940,16 +1122,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 bad319b6..bd1832cd 100644 --- a/src/Model/InlineTemplate.php +++ b/src/Model/InlineTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e03cda89..155d48fd 100644 --- a/src/Model/IntegratedUserInfoList.php +++ b/src/Model/IntegratedUserInfoList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d67334be..0a636fdf 100644 --- a/src/Model/Intermediary.php +++ b/src/Model/Intermediary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -74,6 +77,7 @@ class Intermediary implements ArrayAccess 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'last_name' => 'string', 'name' => 'string', @@ -101,13 +105,84 @@ 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, + 'add_access_code_to_email' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -131,6 +206,7 @@ public static function swaggerTypes() 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'last_name' => 'lastName', 'name' => 'name', @@ -158,9 +234,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -184,6 +260,7 @@ public static function swaggerTypes() 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'last_name' => 'setLastName', 'name' => 'setName', @@ -211,9 +288,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -237,6 +314,7 @@ public static function swaggerTypes() 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'last_name' => 'getLastName', 'name' => 'getName', @@ -264,34 +342,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) { @@ -315,6 +422,7 @@ public function __construct(array $data = null) $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : 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 access_code + * * @return string */ public function getAccessCode() @@ -376,7 +486,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) @@ -388,6 +500,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -397,7 +510,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) @@ -409,6 +524,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -418,7 +534,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) @@ -430,6 +548,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -439,7 +558,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) @@ -451,6 +572,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -460,7 +582,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) @@ -472,6 +596,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -481,7 +606,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) @@ -493,6 +620,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -502,7 +630,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) @@ -514,6 +644,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -523,7 +654,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -535,6 +668,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -544,7 +678,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -556,6 +692,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -565,7 +702,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) @@ -577,6 +716,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -586,7 +726,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) @@ -598,6 +740,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -607,7 +750,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -619,6 +764,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -628,7 +774,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) @@ -640,6 +788,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -649,7 +798,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) @@ -661,6 +812,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -670,7 +822,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) @@ -682,6 +836,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -691,7 +846,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -703,6 +860,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -712,7 +870,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) @@ -724,6 +884,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -733,7 +894,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -745,6 +908,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -754,7 +918,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) @@ -766,6 +932,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -775,7 +942,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) @@ -785,8 +954,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() @@ -796,7 +990,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) @@ -808,6 +1004,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets last_name + * * @return string */ public function getLastName() @@ -817,7 +1014,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -829,6 +1028,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -838,7 +1038,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -850,6 +1052,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -859,7 +1062,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) @@ -871,6 +1076,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -880,7 +1086,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) @@ -892,6 +1100,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -901,7 +1110,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -913,6 +1124,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -922,7 +1134,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) @@ -934,6 +1148,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -943,7 +1158,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) @@ -955,6 +1172,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -964,7 +1182,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -976,6 +1196,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -985,7 +1206,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) @@ -997,6 +1220,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1006,7 +1230,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1018,6 +1244,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1027,7 +1254,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) @@ -1039,6 +1268,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1048,7 +1278,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1060,6 +1292,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1069,7 +1302,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) @@ -1081,6 +1316,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1090,7 +1326,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) @@ -1102,6 +1340,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1111,7 +1350,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) @@ -1123,6 +1364,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1132,7 +1374,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) @@ -1144,6 +1388,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1153,7 +1398,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) @@ -1165,6 +1412,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1174,7 +1422,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) @@ -1186,6 +1436,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1195,7 +1446,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) @@ -1207,6 +1460,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1216,7 +1470,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) @@ -1228,6 +1484,7 @@ public function setStatus($status) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1237,7 +1494,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) @@ -1249,6 +1508,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1258,7 +1518,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) @@ -1270,6 +1532,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1279,7 +1542,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1291,6 +1556,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1300,7 +1566,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1311,7 +1579,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) @@ -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/Jurisdiction.php b/src/Model/Jurisdiction.php index 7844b2ac..37e223b1 100644 --- a/src/Model/Jurisdiction.php +++ b/src/Model/Jurisdiction.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b14552ff..5c626b38 100644 --- a/src/Model/LastName.php +++ b/src/Model/LastName.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -90,13 +93,72 @@ class LastName implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => 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 = [ @@ -136,9 +198,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -178,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -220,34 +282,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) { @@ -288,30 +379,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -321,7 +414,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) @@ -333,6 +428,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -342,7 +438,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) @@ -354,6 +452,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -363,7 +462,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) @@ -375,6 +476,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -384,7 +486,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) @@ -396,6 +500,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -405,7 +510,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) @@ -417,6 +524,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -426,7 +534,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) @@ -438,6 +548,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -447,7 +558,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) @@ -459,6 +572,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -468,7 +582,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) @@ -480,6 +596,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -489,7 +606,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) @@ -501,6 +620,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -510,7 +630,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) @@ -522,6 +644,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -531,7 +654,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) @@ -543,6 +668,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -552,7 +678,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) @@ -564,6 +692,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -573,7 +702,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) @@ -585,6 +716,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -594,7 +726,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) @@ -606,6 +740,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -615,7 +750,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) @@ -627,6 +764,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -636,7 +774,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) @@ -648,6 +788,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -657,7 +798,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) @@ -669,6 +812,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -678,7 +822,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) @@ -690,6 +836,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -699,7 +846,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) @@ -711,6 +860,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -720,7 +870,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -732,6 +884,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -741,7 +894,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) @@ -753,6 +908,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -762,7 +918,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) @@ -774,6 +932,7 @@ public function setRecipientId($recipient_id) /** * Gets status + * * @return string */ public function getStatus() @@ -783,7 +942,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) @@ -795,6 +956,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -804,7 +966,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -816,6 +980,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -825,7 +990,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) @@ -837,6 +1004,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -846,7 +1014,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) @@ -858,6 +1028,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -867,7 +1038,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -879,6 +1052,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -888,7 +1062,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) @@ -900,6 +1076,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -909,7 +1086,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) @@ -921,6 +1100,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -930,7 +1110,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -942,6 +1124,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -951,7 +1134,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) @@ -963,6 +1148,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -972,7 +1158,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -984,6 +1172,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -993,7 +1182,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) @@ -1005,6 +1196,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1014,7 +1206,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) @@ -1025,7 +1219,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) @@ -1035,7 +1231,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1045,8 +1243,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1060,7 +1260,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1070,16 +1272,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 4bbbcb5d..48f2aebe 100644 --- a/src/Model/ListCustomField.php +++ b/src/Model/ListCustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 9ef485e0..06bc4af6 100644 --- a/src/Model/ListItem.php +++ b/src/Model/ListItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -59,13 +62,41 @@ class ListItem implements ArrayAccess 'value' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'selected' => null, + 'text' => 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 = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'value' => 'value' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'value' => 'setValue' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,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) { @@ -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 selected + * * @return string */ public function getSelected() @@ -166,7 +228,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) @@ -178,6 +242,7 @@ public function setSelected($selected) /** * Gets text + * * @return string */ public function getText() @@ -187,7 +252,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) @@ -199,6 +266,7 @@ public function setText($text) /** * Gets value + * * @return string */ public function getValue() @@ -208,7 +276,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) @@ -219,7 +289,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) @@ -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/LockInformation.php b/src/Model/LockInformation.php index aeda047d..84cd1159 100644 --- a/src/Model/LockInformation.php +++ b/src/Model/LockInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 fe60e38e..3c0644d8 100644 --- a/src/Model/LockRequest.php +++ b/src/Model/LockRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 03e842d3..36f1a3d1 100644 --- a/src/Model/LoginAccount.php +++ b/src/Model/LoginAccount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0d6381dd..be742fb6 100644 --- a/src/Model/LoginInformation.php +++ b/src/Model/LoginInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 692b6640..16232adb 100644 --- a/src/Model/MatchBox.php +++ b/src/Model/MatchBox.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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' => 'int' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'height' => 'int32', + 'page_number' => 'int32', + 'width' => 'int32', + 'x_position' => 'int32', + 'y_position' => '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 = [ @@ -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 int */ public function getHeight() @@ -176,7 +240,9 @@ public function getHeight() /** * Sets height + * * @param int $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 int */ public function getPageNumber() @@ -197,7 +264,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) @@ -209,6 +278,7 @@ public function setPageNumber($page_number) /** * Gets width + * * @return int */ public function getWidth() @@ -218,7 +288,9 @@ public function getWidth() /** * Sets width + * * @param int $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 int */ public function getXPosition() @@ -239,7 +312,9 @@ public function getXPosition() /** * Sets x_position + * * @param int $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 int */ public function getYPosition() @@ -260,7 +336,9 @@ public function getYPosition() /** * Sets y_position + * * @param int $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 8ea5f2dc..d3af525a 100644 --- a/src/Model/MemberGroupSharedItem.php +++ b/src/Model/MemberGroupSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 aac27aba..0440785b 100644 --- a/src/Model/MemberSharedItems.php +++ b/src/Model/MemberSharedItems.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ 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, + '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 = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'user' => 'user' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'user' => 'setUser' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,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) { @@ -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 envelopes + * * @return \DocuSign\eSign\Model\SharedItem[] */ public function getEnvelopes() @@ -171,7 +234,9 @@ public function getEnvelopes() /** * Sets envelopes + * * @param \DocuSign\eSign\Model\SharedItem[] $envelopes + * * @return $this */ public function setEnvelopes($envelopes) @@ -183,6 +248,7 @@ public function setEnvelopes($envelopes) /** * 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 templates + * * @return \DocuSign\eSign\Model\TemplateSharedItem[] */ public function getTemplates() @@ -213,7 +282,9 @@ public function getTemplates() /** * Sets templates + * * @param \DocuSign\eSign\Model\TemplateSharedItem[] $templates + * * @return $this */ public function setTemplates($templates) @@ -225,6 +296,7 @@ public function setTemplates($templates) /** * Gets user + * * @return \DocuSign\eSign\Model\UserInfo */ public function getUser() @@ -234,7 +306,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) @@ -245,7 +319,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) @@ -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/MergeField.php b/src/Model/MergeField.php index a88d6060..e02b461a 100644 --- a/src/Model/MergeField.php +++ b/src/Model/MergeField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -62,13 +65,43 @@ class MergeField implements ArrayAccess 'write_back' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'allow_sender_to_edit' => null, + 'configuration_type' => null, + 'path' => null, + 'row' => null, + 'write_back' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'write_back' => 'writeBack' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -92,9 +125,9 @@ public static function swaggerTypes() 'write_back' => 'setWriteBack' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -105,34 +138,63 @@ public static function swaggerTypes() 'write_back' => 'getWriteBack' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 allow_sender_to_edit + * * @return string */ public function getAllowSenderToEdit() @@ -177,7 +241,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) @@ -189,6 +255,7 @@ public function setAllowSenderToEdit($allow_sender_to_edit) /** * Gets configuration_type + * * @return string */ public function getConfigurationType() @@ -198,7 +265,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) @@ -210,6 +279,7 @@ public function setConfigurationType($configuration_type) /** * Gets path + * * @return string */ public function getPath() @@ -219,7 +289,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) @@ -231,6 +303,7 @@ public function setPath($path) /** * Gets row + * * @return string */ public function getRow() @@ -240,7 +313,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) @@ -252,6 +327,7 @@ public function setRow($row) /** * Gets write_back + * * @return string */ public function getWriteBack() @@ -261,7 +337,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) @@ -272,7 +350,9 @@ public function setWriteBack($write_back) } /** * 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/MobileNotifierConfiguration.php b/src/Model/MobileNotifierConfiguration.php index 3d695443..5cf23e28 100644 --- a/src/Model/MobileNotifierConfiguration.php +++ b/src/Model/MobileNotifierConfiguration.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ca525f9f..c3f37c21 100644 --- a/src/Model/MobileNotifierConfigurationInformation.php +++ b/src/Model/MobileNotifierConfigurationInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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..473f81fe --- /dev/null +++ b/src/Model/ModelInterface.php @@ -0,0 +1,96 @@ +<?php +/** + * ModelInterface + * + * PHP version 5 + * + * @category Class + * @package DocuSign\eSign\Model + * @author Swagger Codegen team + * @link https://github.com/swagger-api/swagger-codegen + */ + +/** + * DocuSign REST API + * + * The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. + * + * OpenAPI spec version: v2 + * Contact: devcenter@docusign.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + * Swagger Codegen version: 2.4.13-SNAPSHOT + */ + +/** + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen + * Do not edit the class manually. + */ + +namespace DocuSign\eSign\Model; + +/** + * Interface abstracting model access. + * + * @package DocuSign\eSign\Model + * @author Swagger Codegen team + */ +interface ModelInterface +{ + /** + * The original name of the model. + * + * @return string + */ + public function getModelName(); + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes(); + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats(); + + /** + * Array of attributes where the key is the local name, and the value is the original name + * + * @return array + */ + public static function attributeMap(); + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters(); + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters(); + + /** + * Show all the invalid properties with reasons. + * + * @return array + */ + public function listInvalidProperties(); + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool + */ + public function valid(); +} diff --git a/src/Model/ModelList.php b/src/Model/ModelList.php index 61396094..fd3fd510 100644 --- a/src/Model/ModelList.php +++ b/src/Model/ModelList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * ModelList Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class ModelList implements ArrayAccess +class ModelList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = '_list'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -97,13 +100,79 @@ class ModelList implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'list_items' => null, + 'locked' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -150,9 +219,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -199,9 +268,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -248,34 +317,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) { @@ -323,30 +421,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -356,7 +456,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) @@ -368,6 +470,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -377,7 +480,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) @@ -389,6 +494,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -398,7 +504,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) @@ -410,6 +518,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -419,7 +528,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) @@ -431,6 +542,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -440,7 +552,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) @@ -452,6 +566,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -461,7 +576,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) @@ -473,6 +590,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -482,7 +600,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) @@ -494,6 +614,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -503,7 +624,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) @@ -515,6 +638,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -524,7 +648,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) @@ -536,6 +662,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -545,7 +672,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) @@ -557,6 +686,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -566,7 +696,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) @@ -578,6 +710,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -587,7 +720,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) @@ -599,6 +734,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -608,7 +744,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) @@ -620,6 +758,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -629,7 +768,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) @@ -641,6 +782,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -650,7 +792,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) @@ -662,6 +806,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -671,7 +816,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) @@ -683,6 +830,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -692,7 +840,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) @@ -704,6 +854,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -713,7 +864,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) @@ -725,6 +878,7 @@ public function setItalic($italic) /** * Gets list_items + * * @return \DocuSign\eSign\Model\ListItem[] */ public function getListItems() @@ -734,7 +888,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) @@ -746,6 +902,7 @@ public function setListItems($list_items) /** * Gets locked + * * @return string */ public function getLocked() @@ -755,7 +912,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) @@ -767,6 +926,7 @@ public function setLocked($locked) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -776,7 +936,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) @@ -788,6 +950,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -797,7 +960,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) @@ -809,6 +974,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -818,7 +984,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) @@ -830,6 +998,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -839,7 +1008,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) @@ -851,6 +1022,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -860,7 +1032,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) @@ -872,6 +1046,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -881,7 +1056,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) @@ -893,6 +1070,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -902,7 +1080,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) @@ -914,6 +1094,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -923,7 +1104,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -935,6 +1118,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -944,7 +1128,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) @@ -956,6 +1142,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -965,7 +1152,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -977,6 +1166,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -986,7 +1176,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) @@ -998,6 +1190,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1007,7 +1200,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) @@ -1019,6 +1214,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1028,7 +1224,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1040,6 +1238,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1049,7 +1248,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) @@ -1061,6 +1262,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1070,7 +1272,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) @@ -1082,6 +1286,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1091,7 +1296,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1103,6 +1310,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1112,7 +1320,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) @@ -1124,6 +1334,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -1133,7 +1344,9 @@ public function getValue() /** * Sets value + * * @param string $value The value to use when the item is selected. + * * @return $this */ public function setValue($value) @@ -1145,6 +1358,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1154,7 +1368,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1166,6 +1382,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1175,7 +1392,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) @@ -1187,6 +1406,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1196,7 +1416,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) @@ -1207,7 +1429,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) @@ -1217,7 +1441,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1227,8 +1453,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1242,7 +1470,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1252,16 +1482,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 d1bb4929..f42cd216 100644 --- a/src/Model/Money.php +++ b/src/Model/Money.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 26b7bf7c..ccc42d85 100644 --- a/src/Model/NameValue.php +++ b/src/Model/NameValue.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b5872de8..132ca943 100644 --- a/src/Model/NewAccountDefinition.php +++ b/src/Model/NewAccountDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -68,13 +71,50 @@ 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, + 'distributor_code' => null, + 'distributor_password' => null, + 'envelope_partition_id' => null, + 'initial_user' => 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 = [ @@ -92,9 +132,9 @@ public static function swaggerTypes() 'social_account_information' => 'socialAccountInformation' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'social_account_information' => 'setSocialAccountInformation' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,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) { @@ -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 account_name + * * @return string */ public function getAccountName() @@ -211,7 +282,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) @@ -223,6 +296,7 @@ public function setAccountName($account_name) /** * Gets account_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getAccountSettings() @@ -232,7 +306,9 @@ public function getAccountSettings() /** * Sets account_settings + * * @param \DocuSign\eSign\Model\NameValue[] $account_settings The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden. + * * @return $this */ public function setAccountSettings($account_settings) @@ -244,6 +320,7 @@ public function setAccountSettings($account_settings) /** * Gets address_information + * * @return \DocuSign\eSign\Model\AccountAddress */ public function getAddressInformation() @@ -253,7 +330,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) @@ -265,6 +344,7 @@ public function setAddressInformation($address_information) /** * Gets credit_card_information + * * @return \DocuSign\eSign\Model\CreditCardInformation */ public function getCreditCardInformation() @@ -274,7 +354,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) @@ -286,6 +368,7 @@ public function setCreditCardInformation($credit_card_information) /** * Gets distributor_code + * * @return string */ public function getDistributorCode() @@ -295,7 +378,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) @@ -307,6 +392,7 @@ public function setDistributorCode($distributor_code) /** * Gets distributor_password + * * @return string */ public function getDistributorPassword() @@ -316,7 +402,9 @@ public function getDistributorPassword() /** * Sets distributor_password + * * @param string $distributor_password The password for the distributorCode. + * * @return $this */ public function setDistributorPassword($distributor_password) @@ -328,6 +416,7 @@ public function setDistributorPassword($distributor_password) /** * Gets envelope_partition_id + * * @return string */ public function getEnvelopePartitionId() @@ -337,7 +426,9 @@ public function getEnvelopePartitionId() /** * Sets envelope_partition_id + * * @param string $envelope_partition_id + * * @return $this */ public function setEnvelopePartitionId($envelope_partition_id) @@ -349,6 +440,7 @@ public function setEnvelopePartitionId($envelope_partition_id) /** * Gets initial_user + * * @return \DocuSign\eSign\Model\UserInformation */ public function getInitialUser() @@ -358,7 +450,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) @@ -370,6 +464,7 @@ public function setInitialUser($initial_user) /** * Gets payment_processor_information + * * @return \DocuSign\eSign\Model\PaymentProcessorInformation */ public function getPaymentProcessorInformation() @@ -379,7 +474,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) @@ -391,6 +488,7 @@ public function setPaymentProcessorInformation($payment_processor_information) /** * Gets plan_information + * * @return \DocuSign\eSign\Model\PlanInformation */ public function getPlanInformation() @@ -400,7 +498,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) @@ -412,6 +512,7 @@ public function setPlanInformation($plan_information) /** * Gets referral_information + * * @return \DocuSign\eSign\Model\ReferralInformation */ public function getReferralInformation() @@ -421,7 +522,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) @@ -433,6 +536,7 @@ public function setReferralInformation($referral_information) /** * Gets social_account_information + * * @return \DocuSign\eSign\Model\SocialAccountInformation */ public function getSocialAccountInformation() @@ -442,7 +546,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) @@ -453,7 +559,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) @@ -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/NewAccountSummary.php b/src/Model/NewAccountSummary.php index 09b017e9..b29ee7b3 100644 --- a/src/Model/NewAccountSummary.php +++ b/src/Model/NewAccountSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 2def4c1b..3a6de137 100644 --- a/src/Model/NewUser.php +++ b/src/Model/NewUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6c3b5695..5b717e53 100644 --- a/src/Model/NewUsersDefinition.php +++ b/src/Model/NewUsersDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b1dc3ae5..6871906e 100644 --- a/src/Model/NewUsersSummary.php +++ b/src/Model/NewUsersSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3fe64f5a..06b3b9b3 100644 --- a/src/Model/Notarize.php +++ b/src/Model/Notarize.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -83,13 +86,65 @@ class Notarize implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'locked' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'required' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -122,9 +177,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -157,9 +212,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -192,34 +247,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) { @@ -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 anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -286,7 +372,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) @@ -298,6 +386,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -307,7 +396,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) @@ -319,6 +410,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -328,7 +420,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) @@ -340,6 +434,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -349,7 +444,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) @@ -361,6 +458,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -370,7 +468,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) @@ -382,6 +482,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -391,7 +492,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) @@ -403,6 +506,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -412,7 +516,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) @@ -424,6 +530,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -433,7 +540,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) @@ -445,6 +554,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -454,7 +564,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) @@ -466,6 +578,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -475,7 +588,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) @@ -487,6 +602,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -496,7 +612,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) @@ -508,6 +626,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -517,7 +636,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) @@ -529,6 +650,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -538,7 +660,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) @@ -550,6 +674,7 @@ public function setErrorDetails($error_details) /** * Gets locked + * * @return string */ public function getLocked() @@ -559,7 +684,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) @@ -571,6 +698,7 @@ public function setLocked($locked) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -580,7 +708,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) @@ -592,6 +722,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -601,7 +732,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) @@ -613,6 +746,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -622,7 +756,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) @@ -634,6 +770,7 @@ public function setRecipientId($recipient_id) /** * Gets required + * * @return string */ public function getRequired() @@ -643,7 +780,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) @@ -655,6 +794,7 @@ public function setRequired($required) /** * Gets status + * * @return string */ public function getStatus() @@ -664,7 +804,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) @@ -676,6 +818,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -685,7 +828,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -697,6 +842,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -706,7 +852,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) @@ -718,6 +866,7 @@ public function setTabId($tab_id) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -727,7 +876,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -739,6 +890,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -748,7 +900,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) @@ -760,6 +914,7 @@ public function setTemplateLocked($template_locked) /** * 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 tooltip + * * @return string */ public function getTooltip() @@ -790,7 +948,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -802,6 +962,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -811,7 +972,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) @@ -823,6 +986,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -832,7 +996,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) @@ -843,7 +1009,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) @@ -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/NotaryHost.php b/src/Model/NotaryHost.php index 3d14aa8c..fc9512e8 100644 --- a/src/Model/NotaryHost.php +++ b/src/Model/NotaryHost.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -71,6 +74,7 @@ class NotaryHost implements ArrayAccess 'host_recipient_id' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'name' => 'string', 'note' => 'string', @@ -95,13 +99,78 @@ 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, + 'add_access_code_to_email' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'host_recipient_id' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -122,6 +191,7 @@ public static function swaggerTypes() 'host_recipient_id' => 'hostRecipientId', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'name' => 'name', 'note' => 'note', @@ -146,9 +216,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -169,6 +239,7 @@ public static function swaggerTypes() 'host_recipient_id' => 'setHostRecipientId', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'name' => 'setName', 'note' => 'setNote', @@ -193,9 +264,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -216,6 +287,7 @@ public static function swaggerTypes() 'host_recipient_id' => 'getHostRecipientId', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'name' => 'getName', 'note' => 'getNote', @@ -240,34 +312,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) { @@ -288,6 +389,7 @@ public function __construct(array $data = null) $this->container['host_recipient_id'] = isset($data['host_recipient_id']) ? $data['host_recipient_id'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; @@ -313,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 access_code + * * @return string */ public function getAccessCode() @@ -346,7 +450,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) @@ -358,6 +464,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -367,7 +474,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) @@ -379,6 +488,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -388,7 +498,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) @@ -400,6 +512,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -409,7 +522,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) @@ -421,6 +536,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -430,7 +546,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) @@ -442,6 +560,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -451,7 +570,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) @@ -463,6 +584,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -472,7 +594,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) @@ -484,6 +608,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -493,7 +618,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -505,6 +632,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -514,7 +642,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -526,6 +656,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -535,7 +666,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -547,6 +680,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -556,7 +690,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) @@ -568,6 +704,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -577,7 +714,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) @@ -589,6 +728,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -598,7 +738,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) @@ -610,6 +752,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -619,7 +762,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -631,6 +776,7 @@ public function setFaxNumber($fax_number) /** * Gets host_recipient_id + * * @return string */ public function getHostRecipientId() @@ -640,7 +786,9 @@ public function getHostRecipientId() /** * Sets host_recipient_id + * * @param string $host_recipient_id + * * @return $this */ public function setHostRecipientId($host_recipient_id) @@ -652,6 +800,7 @@ public function setHostRecipientId($host_recipient_id) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -661,7 +810,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) @@ -673,6 +824,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -682,7 +834,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) @@ -692,8 +846,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() @@ -703,7 +882,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) @@ -715,6 +896,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets name + * * @return string */ public function getName() @@ -724,7 +906,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -736,6 +920,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -745,7 +930,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) @@ -757,6 +944,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -766,7 +954,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) @@ -778,6 +968,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -787,7 +978,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -799,6 +992,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -808,7 +1002,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) @@ -820,6 +1016,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -829,7 +1026,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) @@ -841,6 +1040,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -850,7 +1050,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -862,6 +1064,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -871,7 +1074,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) @@ -883,6 +1088,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -892,7 +1098,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -904,6 +1112,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -913,7 +1122,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) @@ -925,6 +1136,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -934,7 +1146,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -946,6 +1160,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -955,7 +1170,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) @@ -967,6 +1184,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -976,7 +1194,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) @@ -988,6 +1208,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -997,7 +1218,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) @@ -1009,6 +1232,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1018,7 +1242,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) @@ -1030,6 +1256,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1039,7 +1266,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) @@ -1051,6 +1280,7 @@ public function setStatus($status) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1060,7 +1290,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) @@ -1072,6 +1304,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1081,7 +1314,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) @@ -1093,6 +1328,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1102,7 +1338,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) @@ -1114,6 +1352,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1123,7 +1362,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1135,6 +1376,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1144,7 +1386,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1155,7 +1399,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) @@ -1165,7 +1411,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1175,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) @@ -1190,7 +1440,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1200,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/NotaryJournal.php b/src/Model/NotaryJournal.php index a9c1194d..90dae8c7 100644 --- a/src/Model/NotaryJournal.php +++ b/src/Model/NotaryJournal.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ac4777d9..7437cecd 100644 --- a/src/Model/NotaryJournalCredibleWitness.php +++ b/src/Model/NotaryJournalCredibleWitness.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0ebfd255..88b519e2 100644 --- a/src/Model/NotaryJournalList.php +++ b/src/Model/NotaryJournalList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0fb384fc..e4fbf14c 100644 --- a/src/Model/NotaryJournalMetaData.php +++ b/src/Model/NotaryJournalMetaData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/Note.php b/src/Model/Note.php index 9bf81dad..9ddea047 100644 --- a/src/Model/Note.php +++ b/src/Model/Note.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -93,13 +96,75 @@ class Note implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'height' => 'int32', + 'italic' => null, + 'merge_field' => null, + 'name' => null, + 'page_number' => null, + 'recipient_id' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -142,9 +207,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -187,9 +252,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -232,34 +297,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) { @@ -303,30 +397,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -336,7 +432,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) @@ -348,6 +446,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -357,7 +456,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) @@ -369,6 +470,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -378,7 +480,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) @@ -390,6 +494,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -399,7 +504,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) @@ -411,6 +518,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -420,7 +528,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) @@ -432,6 +542,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -441,7 +552,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) @@ -453,6 +566,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -462,7 +576,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) @@ -474,6 +590,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -483,7 +600,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) @@ -495,6 +614,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -504,7 +624,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) @@ -516,6 +638,7 @@ public function setBold($bold) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -525,7 +648,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) @@ -537,6 +662,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -546,7 +672,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) @@ -558,6 +686,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -567,7 +696,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) @@ -579,6 +710,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -588,7 +720,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) @@ -600,6 +734,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -609,7 +744,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) @@ -621,6 +758,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -630,7 +768,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) @@ -642,6 +782,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -651,7 +792,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) @@ -663,6 +806,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -672,7 +816,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) @@ -684,6 +830,7 @@ public function setFontSize($font_size) /** * Gets height + * * @return int */ public function getHeight() @@ -693,7 +840,9 @@ public function getHeight() /** * Sets height + * * @param int $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -705,6 +854,7 @@ public function setHeight($height) /** * Gets italic + * * @return string */ public function getItalic() @@ -714,7 +864,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) @@ -726,6 +878,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -735,7 +888,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) @@ -747,6 +902,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -756,7 +912,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -768,6 +926,7 @@ public function setName($name) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -777,7 +936,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) @@ -789,6 +950,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -798,7 +960,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) @@ -810,6 +974,7 @@ public function setRecipientId($recipient_id) /** * Gets shared + * * @return string */ public function getShared() @@ -819,7 +984,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -831,6 +998,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -840,7 +1008,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) @@ -852,6 +1022,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -861,7 +1032,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -873,6 +1046,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -882,7 +1056,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) @@ -894,6 +1070,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -903,7 +1080,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) @@ -915,6 +1094,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -924,7 +1104,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -936,6 +1118,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -945,7 +1128,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) @@ -957,6 +1142,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -966,7 +1152,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) @@ -978,6 +1166,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -987,7 +1176,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -999,6 +1190,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1008,7 +1200,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) @@ -1020,6 +1214,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -1029,7 +1224,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1041,6 +1238,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1050,7 +1248,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1062,6 +1262,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1071,7 +1272,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) @@ -1083,6 +1286,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1092,7 +1296,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) @@ -1103,7 +1309,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) @@ -1113,7 +1321,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1123,8 +1333,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1138,7 +1350,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1148,16 +1362,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 dd02c6f4..f22b4015 100644 --- a/src/Model/Notification.php +++ b/src/Model/Notification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/Number.php b/src/Model/Number.php index 5e2f9742..061a1fa4 100644 --- a/src/Model/Number.php +++ b/src/Model/Number.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -105,13 +108,87 @@ class Number implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'formula' => null, + 'is_payment_amount' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -166,9 +243,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -223,9 +300,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -280,34 +357,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) { @@ -363,30 +469,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -396,7 +504,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) @@ -408,6 +518,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -417,7 +528,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) @@ -429,6 +542,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -438,7 +552,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) @@ -450,6 +566,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -459,7 +576,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) @@ -471,6 +590,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -480,7 +600,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) @@ -492,6 +614,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -501,7 +624,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) @@ -513,6 +638,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -522,7 +648,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) @@ -534,6 +662,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -543,7 +672,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) @@ -555,6 +686,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -564,7 +696,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) @@ -576,6 +710,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -585,7 +720,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) @@ -597,6 +734,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -606,7 +744,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) @@ -618,6 +758,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -627,7 +768,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) @@ -639,6 +782,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -648,7 +792,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) @@ -660,6 +806,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -669,7 +816,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) @@ -681,6 +830,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -690,7 +840,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) @@ -702,6 +854,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -711,7 +864,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) @@ -723,6 +878,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -732,7 +888,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) @@ -744,6 +902,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -753,7 +912,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) @@ -765,6 +926,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -774,7 +936,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) @@ -786,6 +950,7 @@ public function setFontSize($font_size) /** * Gets formula + * * @return string */ public function getFormula() @@ -795,7 +960,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) @@ -807,6 +974,7 @@ public function setFormula($formula) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -816,7 +984,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) @@ -828,6 +998,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets italic + * * @return string */ public function getItalic() @@ -837,7 +1008,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) @@ -849,6 +1022,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -858,7 +1032,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) @@ -870,6 +1046,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -879,7 +1056,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -891,6 +1070,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -900,7 +1080,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) @@ -912,6 +1094,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -921,7 +1104,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -933,6 +1118,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -942,7 +1128,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) @@ -954,6 +1142,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -963,7 +1152,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) @@ -975,6 +1166,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -984,7 +1176,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) @@ -996,6 +1190,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -1005,7 +1200,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) @@ -1017,6 +1214,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -1026,7 +1224,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) @@ -1038,6 +1238,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -1047,7 +1248,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) @@ -1059,6 +1262,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1068,7 +1272,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) @@ -1080,6 +1286,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1089,7 +1296,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1101,6 +1310,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1110,7 +1320,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) @@ -1122,6 +1334,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1131,7 +1344,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1143,6 +1358,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1152,7 +1368,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) @@ -1164,6 +1382,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1173,7 +1392,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) @@ -1185,6 +1406,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1194,7 +1416,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1206,6 +1430,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1215,7 +1440,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) @@ -1227,6 +1454,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1236,7 +1464,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) @@ -1248,6 +1478,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1257,7 +1488,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1269,6 +1502,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1278,7 +1512,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) @@ -1290,6 +1526,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1299,7 +1536,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) @@ -1311,6 +1550,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1320,7 +1560,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) @@ -1332,6 +1574,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1341,7 +1584,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1353,6 +1598,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1362,7 +1608,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1374,6 +1622,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1383,7 +1632,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) @@ -1395,6 +1646,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1404,7 +1656,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) @@ -1415,7 +1669,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) @@ -1425,7 +1681,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1435,8 +1693,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1450,7 +1710,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1460,16 +1722,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 ab87d6c7..cd9a30f6 100644 --- a/src/Model/OauthAccess.php +++ b/src/Model/OauthAccess.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 084f8f36..3fc7740d 100644 --- a/src/Model/OfflineAttributes.php +++ b/src/Model/OfflineAttributes.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6245f774..d4c08c7a 100644 --- a/src/Model/Page.php +++ b/src/Model/Page.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 f194f485..5cd22ef6 100644 --- a/src/Model/PageImages.php +++ b/src/Model/PageImages.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 065883a6..8752a55c 100644 --- a/src/Model/PageRequest.php +++ b/src/Model/PageRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/PaymentDetails.php b/src/Model/PaymentDetails.php index 4e760cfb..ed75858f 100644 --- a/src/Model/PaymentDetails.php +++ b/src/Model/PaymentDetails.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -70,13 +73,52 @@ 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, + 'customer_id' => null, + 'custom_metadata' => null, + 'custom_metadata_required' => null, + 'gateway_account_id' => 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 = [ @@ -96,9 +138,9 @@ public static function swaggerTypes() 'total' => 'total' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -118,9 +160,9 @@ public static function swaggerTypes() 'total' => 'setTotal' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -140,34 +182,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) { @@ -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 allowed_payment_methods + * * @return string[] */ public function getAllowedPaymentMethods() @@ -221,7 +294,9 @@ public function getAllowedPaymentMethods() /** * Sets allowed_payment_methods + * * @param string[] $allowed_payment_methods + * * @return $this */ public function setAllowedPaymentMethods($allowed_payment_methods) @@ -233,6 +308,7 @@ public function setAllowedPaymentMethods($allowed_payment_methods) /** * Gets charge_id + * * @return string */ public function getChargeId() @@ -242,7 +318,9 @@ public function getChargeId() /** * Sets charge_id + * * @param string $charge_id + * * @return $this */ public function setChargeId($charge_id) @@ -254,6 +332,7 @@ public function setChargeId($charge_id) /** * Gets currency_code + * * @return string */ public function getCurrencyCode() @@ -263,7 +342,9 @@ public function getCurrencyCode() /** * Sets currency_code + * * @param string $currency_code + * * @return $this */ public function setCurrencyCode($currency_code) @@ -275,6 +356,7 @@ public function setCurrencyCode($currency_code) /** * Gets customer_id + * * @return string */ public function getCustomerId() @@ -284,7 +366,9 @@ public function getCustomerId() /** * Sets customer_id + * * @param string $customer_id + * * @return $this */ public function setCustomerId($customer_id) @@ -296,6 +380,7 @@ public function setCustomerId($customer_id) /** * Gets custom_metadata + * * @return string */ public function getCustomMetadata() @@ -305,7 +390,9 @@ public function getCustomMetadata() /** * Sets custom_metadata + * * @param string $custom_metadata + * * @return $this */ public function setCustomMetadata($custom_metadata) @@ -317,6 +404,7 @@ public function setCustomMetadata($custom_metadata) /** * Gets custom_metadata_required + * * @return bool */ public function getCustomMetadataRequired() @@ -326,7 +414,9 @@ public function getCustomMetadataRequired() /** * Sets custom_metadata_required + * * @param bool $custom_metadata_required + * * @return $this */ public function setCustomMetadataRequired($custom_metadata_required) @@ -338,6 +428,7 @@ public function setCustomMetadataRequired($custom_metadata_required) /** * Gets gateway_account_id + * * @return string */ public function getGatewayAccountId() @@ -347,7 +438,9 @@ public function getGatewayAccountId() /** * Sets gateway_account_id + * * @param string $gateway_account_id + * * @return $this */ public function setGatewayAccountId($gateway_account_id) @@ -359,6 +452,7 @@ public function setGatewayAccountId($gateway_account_id) /** * Gets gateway_display_name + * * @return string */ public function getGatewayDisplayName() @@ -368,7 +462,9 @@ public function getGatewayDisplayName() /** * Sets gateway_display_name + * * @param string $gateway_display_name + * * @return $this */ public function setGatewayDisplayName($gateway_display_name) @@ -380,6 +476,7 @@ public function setGatewayDisplayName($gateway_display_name) /** * Gets gateway_name + * * @return string */ public function getGatewayName() @@ -389,7 +486,9 @@ public function getGatewayName() /** * Sets gateway_name + * * @param string $gateway_name + * * @return $this */ public function setGatewayName($gateway_name) @@ -401,6 +500,7 @@ public function setGatewayName($gateway_name) /** * Gets line_items + * * @return \DocuSign\eSign\Model\PaymentLineItem[] */ public function getLineItems() @@ -410,7 +510,9 @@ public function getLineItems() /** * Sets line_items + * * @param \DocuSign\eSign\Model\PaymentLineItem[] $line_items + * * @return $this */ public function setLineItems($line_items) @@ -422,6 +524,7 @@ public function setLineItems($line_items) /** * Gets payment_option + * * @return string */ public function getPaymentOption() @@ -431,7 +534,9 @@ public function getPaymentOption() /** * Sets payment_option + * * @param string $payment_option + * * @return $this */ public function setPaymentOption($payment_option) @@ -443,6 +548,7 @@ public function setPaymentOption($payment_option) /** * Gets payment_source_id + * * @return string */ public function getPaymentSourceId() @@ -452,7 +558,9 @@ public function getPaymentSourceId() /** * Sets payment_source_id + * * @param string $payment_source_id + * * @return $this */ public function setPaymentSourceId($payment_source_id) @@ -464,6 +572,7 @@ public function setPaymentSourceId($payment_source_id) /** * Gets status + * * @return string */ public function getStatus() @@ -473,7 +582,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) @@ -485,6 +596,7 @@ public function setStatus($status) /** * Gets total + * * @return \DocuSign\eSign\Model\Money */ public function getTotal() @@ -494,7 +606,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) @@ -505,7 +619,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) @@ -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/PaymentGatewayAccount.php b/src/Model/PaymentGatewayAccount.php index 79198690..e3a9bc81 100644 --- a/src/Model/PaymentGatewayAccount.php +++ b/src/Model/PaymentGatewayAccount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ class PaymentGatewayAccount implements ArrayAccess 'payment_gateway_display_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'display_name' => null, + 'payment_gateway' => null, + 'payment_gateway_account_id' => null, + 'payment_gateway_display_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() 'payment_gateway_display_name' => 'paymentGatewayDisplayName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'payment_gateway_display_name' => 'setPaymentGatewayDisplayName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'payment_gateway_display_name' => 'getPaymentGatewayDisplayName' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 display_name + * * @return string */ public function getDisplayName() @@ -171,7 +234,9 @@ public function getDisplayName() /** * Sets display_name + * * @param string $display_name + * * @return $this */ public function setDisplayName($display_name) @@ -183,6 +248,7 @@ public function setDisplayName($display_name) /** * Gets payment_gateway + * * @return string */ public function getPaymentGateway() @@ -192,7 +258,9 @@ public function getPaymentGateway() /** * Sets payment_gateway + * * @param string $payment_gateway + * * @return $this */ public function setPaymentGateway($payment_gateway) @@ -204,6 +272,7 @@ public function setPaymentGateway($payment_gateway) /** * Gets payment_gateway_account_id + * * @return string */ public function getPaymentGatewayAccountId() @@ -213,7 +282,9 @@ public function getPaymentGatewayAccountId() /** * Sets payment_gateway_account_id + * * @param string $payment_gateway_account_id + * * @return $this */ public function setPaymentGatewayAccountId($payment_gateway_account_id) @@ -225,6 +296,7 @@ public function setPaymentGatewayAccountId($payment_gateway_account_id) /** * Gets payment_gateway_display_name + * * @return string */ public function getPaymentGatewayDisplayName() @@ -234,7 +306,9 @@ public function getPaymentGatewayDisplayName() /** * Sets payment_gateway_display_name + * * @param string $payment_gateway_display_name + * * @return $this */ public function setPaymentGatewayDisplayName($payment_gateway_display_name) @@ -245,7 +319,9 @@ public function setPaymentGatewayDisplayName($payment_gateway_display_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/PaymentGatewayAccountsInfo.php b/src/Model/PaymentGatewayAccountsInfo.php index 9acfa7a9..749df7bf 100644 --- a/src/Model/PaymentGatewayAccountsInfo.php +++ b/src/Model/PaymentGatewayAccountsInfo.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 800ddc90..4d292ac7 100644 --- a/src/Model/PaymentLineItem.php +++ b/src/Model/PaymentLineItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/PaymentProcessorInformation.php b/src/Model/PaymentProcessorInformation.php index ed7c95d2..11dcdf90 100644 --- a/src/Model/PaymentProcessorInformation.php +++ b/src/Model/PaymentProcessorInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 4f72d427..ff07faa7 100644 --- a/src/Model/PermissionProfile.php +++ b/src/Model/PermissionProfile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5e33ec7b..ef75e813 100644 --- a/src/Model/PermissionProfileInformation.php +++ b/src/Model/PermissionProfileInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a31211a8..b723c70d 100644 --- a/src/Model/PlanInformation.php +++ b/src/Model/PlanInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/PowerForm.php b/src/Model/PowerForm.php index b4d04d54..0e8a38d6 100644 --- a/src/Model/PowerForm.php +++ b/src/Model/PowerForm.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 7f5f0456..4e9d427b 100644 --- a/src/Model/PowerFormFormDataEnvelope.php +++ b/src/Model/PowerFormFormDataEnvelope.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e36266e5..69ff1c73 100644 --- a/src/Model/PowerFormFormDataRecipient.php +++ b/src/Model/PowerFormFormDataRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 887f9af9..807d69ef 100644 --- a/src/Model/PowerFormRecipient.php +++ b/src/Model/PowerFormRecipient.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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.<br/><br/>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 b3e0133c..d5030e0f 100644 --- a/src/Model/PowerFormSendersResponse.php +++ b/src/Model/PowerFormSendersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'power_form_senders' => 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 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 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/PowerFormsFormDataResponse.php b/src/Model/PowerFormsFormDataResponse.php index 001694ed..0d193ef2 100644 --- a/src/Model/PowerFormsFormDataResponse.php +++ b/src/Model/PowerFormsFormDataResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 bcb23923..f9d1b20a 100644 --- a/src/Model/PowerFormsRequest.php +++ b/src/Model/PowerFormsRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 76c07332..176bc73a 100644 --- a/src/Model/PowerFormsResponse.php +++ b/src/Model/PowerFormsResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'end_position' => null, + 'next_uri' => null, + 'power_forms' => 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 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 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/PropertyMetadata.php b/src/Model/PropertyMetadata.php index 4d01d5eb..dadc962a 100644 --- a/src/Model/PropertyMetadata.php +++ b/src/Model/PropertyMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e32ea7b0..742206f1 100644 --- a/src/Model/Province.php +++ b/src/Model/Province.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 2cd8a57b..f04b3d5d 100644 --- a/src/Model/ProvisioningInformation.php +++ b/src/Model/ProvisioningInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 47a43225..0ccf9ec1 100644 --- a/src/Model/PurchasedEnvelopesInformation.php +++ b/src/Model/PurchasedEnvelopesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ec5b0745..f1f25023 100644 --- a/src/Model/Radio.php +++ b/src/Model/Radio.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -74,13 +77,56 @@ class Radio implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'error_details' => null, + 'locked' => null, + 'page_number' => null, + 'required' => null, + 'selected' => null, + 'tab_id' => null, + 'tab_order' => null, + 'value' => 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 = [ @@ -104,9 +150,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -130,9 +176,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -156,34 +202,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) { @@ -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 anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -241,7 +318,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) @@ -253,6 +332,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -262,7 +342,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) @@ -274,6 +356,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -283,7 +366,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) @@ -295,6 +380,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -304,7 +390,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) @@ -316,6 +404,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -325,7 +414,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) @@ -337,6 +428,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -346,7 +438,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) @@ -358,6 +452,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -367,7 +462,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) @@ -379,6 +476,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -388,7 +486,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) @@ -400,6 +500,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -409,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) @@ -421,6 +524,7 @@ public function setErrorDetails($error_details) /** * Gets locked + * * @return string */ public function getLocked() @@ -430,7 +534,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) @@ -442,6 +548,7 @@ public function setLocked($locked) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -451,7 +558,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) @@ -463,6 +572,7 @@ public function setPageNumber($page_number) /** * Gets required + * * @return string */ public function getRequired() @@ -472,7 +582,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) @@ -484,6 +596,7 @@ public function setRequired($required) /** * Gets selected + * * @return string */ public function getSelected() @@ -493,7 +606,9 @@ public function getSelected() /** * Sets selected + * * @param string $selected When set to **true**, the radio button is selected. + * * @return $this */ public function setSelected($selected) @@ -505,6 +620,7 @@ public function setSelected($selected) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -514,7 +630,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) @@ -526,6 +644,7 @@ public function setTabId($tab_id) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -535,7 +654,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -547,6 +668,7 @@ public function setTabOrder($tab_order) /** * Gets value + * * @return string */ public function getValue() @@ -556,7 +678,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -568,6 +692,7 @@ public function setValue($value) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -577,7 +702,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) @@ -589,6 +716,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -598,7 +726,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) @@ -609,7 +739,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) @@ -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/RadioGroup.php b/src/Model/RadioGroup.php index 6b6ab501..5295ebc5 100644 --- a/src/Model/RadioGroup.php +++ b/src/Model/RadioGroup.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -68,13 +71,50 @@ class RadioGroup implements ArrayAccess 'tooltip' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'document_id' => null, + 'group_name' => null, + 'radios' => null, + 'recipient_id' => null, + 'require_all' => null, + 'require_initial_on_shared_change' => null, + 'shared' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'tooltip' => 'tooltip' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -112,9 +152,9 @@ public static function swaggerTypes() 'tooltip' => 'setTooltip' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -132,34 +172,63 @@ public static function swaggerTypes() 'tooltip' => 'getTooltip' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -211,7 +282,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) @@ -223,6 +296,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -232,7 +306,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) @@ -244,6 +320,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -253,7 +330,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) @@ -265,6 +344,7 @@ public function setDocumentId($document_id) /** * Gets group_name + * * @return string */ public function getGroupName() @@ -274,7 +354,9 @@ public function getGroupName() /** * Sets group_name + * * @param string $group_name The name of the group. + * * @return $this */ public function setGroupName($group_name) @@ -286,6 +368,7 @@ public function setGroupName($group_name) /** * Gets radios + * * @return \DocuSign\eSign\Model\Radio[] */ public function getRadios() @@ -295,7 +378,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) @@ -307,6 +392,7 @@ public function setRadios($radios) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -316,7 +402,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) @@ -328,6 +416,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -337,7 +426,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) @@ -349,6 +440,7 @@ public function setRequireAll($require_all) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -358,7 +450,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) @@ -370,6 +464,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets shared + * * @return string */ public function getShared() @@ -379,7 +474,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -391,6 +488,7 @@ public function setShared($shared) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -400,7 +498,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) @@ -412,6 +512,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -421,7 +522,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) @@ -433,6 +536,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -442,7 +546,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -453,7 +559,9 @@ public function setTooltip($tooltip) } /** * 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/RecipientAttachment.php b/src/Model/RecipientAttachment.php index 774df923..b8980546 100644 --- a/src/Model/RecipientAttachment.php +++ b/src/Model/RecipientAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0267e637..c85bad4c 100644 --- a/src/Model/RecipientDomain.php +++ b/src/Model/RecipientDomain.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 313f5f9a..52dad8e5 100644 --- a/src/Model/RecipientEmailNotification.php +++ b/src/Model/RecipientEmailNotification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -59,13 +62,41 @@ class RecipientEmailNotification implements ArrayAccess 'supported_language' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'email_body' => null, + 'email_subject' => null, + 'supported_language' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'supported_language' => 'supportedLanguage' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'supported_language' => 'setSupportedLanguage' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,63 @@ public static function swaggerTypes() 'supported_language' => 'getSupportedLanguage' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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_body + * * @return string */ public function getEmailBody() @@ -166,7 +228,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) @@ -178,6 +242,7 @@ public function setEmailBody($email_body) /** * Gets email_subject + * * @return string */ public function getEmailSubject() @@ -187,7 +252,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) @@ -199,6 +266,7 @@ public function setEmailSubject($email_subject) /** * Gets supported_language + * * @return string */ public function getSupportedLanguage() @@ -208,7 +276,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) @@ -219,7 +289,9 @@ public function setSupportedLanguage($supported_language) } /** * 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/RecipientEvent.php b/src/Model/RecipientEvent.php index 7feb5d19..03f36395 100644 --- a/src/Model/RecipientEvent.php +++ b/src/Model/RecipientEvent.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a195b57c..001d3e82 100644 --- a/src/Model/RecipientFormData.php +++ b/src/Model/RecipientFormData.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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\NameValue[] */ public function getFormData() @@ -254,7 +330,9 @@ public function getFormData() /** * Sets form_data + * * @param \DocuSign\eSign\Model\NameValue[] $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 ed679d44..1fef32e1 100644 --- a/src/Model/RecipientIdentityInputOption.php +++ b/src/Model/RecipientIdentityInputOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ac80fc1a..a926cab2 100644 --- a/src/Model/RecipientIdentityPhoneNumber.php +++ b/src/Model/RecipientIdentityPhoneNumber.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 81e60303..61623679 100644 --- a/src/Model/RecipientIdentityVerification.php +++ b/src/Model/RecipientIdentityVerification.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 87024aa6..8e597dc6 100644 --- a/src/Model/RecipientNamesResponse.php +++ b/src/Model/RecipientNamesResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3fcb5596..6666e74c 100644 --- a/src/Model/RecipientPhoneAuthentication.php +++ b/src/Model/RecipientPhoneAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -61,13 +64,42 @@ class RecipientPhoneAuthentication implements ArrayAccess 'validate_recip_provided_number' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'recip_may_provide_number' => null, + 'record_voice_print' => null, + 'sender_provided_numbers' => null, + 'validate_recip_provided_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 = [ @@ -77,9 +109,9 @@ public static function swaggerTypes() 'validate_recip_provided_number' => 'validateRecipProvidedNumber' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -89,9 +121,9 @@ public static function swaggerTypes() 'validate_recip_provided_number' => 'setValidateRecipProvidedNumber' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -101,34 +133,63 @@ public static function swaggerTypes() 'validate_recip_provided_number' => 'getValidateRecipProvidedNumber' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 recip_may_provide_number + * * @return string */ public function getRecipMayProvideNumber() @@ -172,7 +235,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) @@ -184,6 +249,7 @@ public function setRecipMayProvideNumber($recip_may_provide_number) /** * Gets record_voice_print + * * @return string */ public function getRecordVoicePrint() @@ -193,7 +259,9 @@ public function getRecordVoicePrint() /** * Sets record_voice_print + * * @param string $record_voice_print Reserved. + * * @return $this */ public function setRecordVoicePrint($record_voice_print) @@ -205,6 +273,7 @@ public function setRecordVoicePrint($record_voice_print) /** * Gets sender_provided_numbers + * * @return string[] */ public function getSenderProvidedNumbers() @@ -214,7 +283,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) @@ -226,6 +297,7 @@ public function setSenderProvidedNumbers($sender_provided_numbers) /** * Gets validate_recip_provided_number + * * @return string */ public function getValidateRecipProvidedNumber() @@ -235,7 +307,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) @@ -246,7 +320,9 @@ public function setValidateRecipProvidedNumber($validate_recip_provided_number) } /** * 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/RecipientProofFile.php b/src/Model/RecipientProofFile.php index 9412639e..6d6af251 100644 --- a/src/Model/RecipientProofFile.php +++ b/src/Model/RecipientProofFile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/RecipientSAMLAuthentication.php b/src/Model/RecipientSAMLAuthentication.php index a8e59e95..7cf66af0 100644 --- a/src/Model/RecipientSAMLAuthentication.php +++ b/src/Model/RecipientSAMLAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * RecipientSAMLAuthentication Class Doc Comment @@ -40,83 +41,140 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class RecipientSAMLAuthentication implements ArrayAccess +class RecipientSAMLAuthentication implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'recipientSAMLAuthentication'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ 'saml_assertion_attributes' => '\DocuSign\eSign\Model\SamlAssertionAttribute[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'saml_assertion_attributes' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'saml_assertion_attributes' => 'samlAssertionAttributes' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'saml_assertion_attributes' => 'setSamlAssertionAttributes' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'saml_assertion_attributes' => 'getSamlAssertionAttributes' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 saml_assertion_attributes + * * @return \DocuSign\eSign\Model\SamlAssertionAttribute[] */ public function getSamlAssertionAttributes() @@ -157,7 +217,9 @@ public function getSamlAssertionAttributes() /** * Sets saml_assertion_attributes + * * @param \DocuSign\eSign\Model\SamlAssertionAttribute[] $saml_assertion_attributes + * * @return $this */ public function setSamlAssertionAttributes($saml_assertion_attributes) @@ -168,7 +230,9 @@ public function setSamlAssertionAttributes($saml_assertion_attributes) } /** * 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/RecipientSMSAuthentication.php b/src/Model/RecipientSMSAuthentication.php index de10ff02..7a1fc448 100644 --- a/src/Model/RecipientSMSAuthentication.php +++ b/src/Model/RecipientSMSAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,83 +41,140 @@ * @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 = [ 'sender_provided_numbers' => 'string[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'sender_provided_numbers' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * * @var string[] */ protected static $attributeMap = [ 'sender_provided_numbers' => 'senderProvidedNumbers' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ 'sender_provided_numbers' => 'setSenderProvidedNumbers' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ 'sender_provided_numbers' => 'getSenderProvidedNumbers' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 sender_provided_numbers + * * @return string[] */ public function getSenderProvidedNumbers() @@ -157,7 +217,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) @@ -168,7 +230,9 @@ public function setSenderProvidedNumbers($sender_provided_numbers) } /** * 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/RecipientSignatureInformation.php b/src/Model/RecipientSignatureInformation.php index 22f4f774..5ccfc13d 100644 --- a/src/Model/RecipientSignatureInformation.php +++ b/src/Model/RecipientSignatureInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e6ad032a..5b2ce3a1 100644 --- a/src/Model/RecipientSignatureProvider.php +++ b/src/Model/RecipientSignatureProvider.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ 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_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 = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'signature_provider_options' => 'signatureProviderOptions' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'signature_provider_options' => 'setSignatureProviderOptions' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,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) { @@ -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 seal_documents_with_tabs_only + * * @return string */ public function getSealDocumentsWithTabsOnly() @@ -171,7 +234,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) @@ -183,6 +248,7 @@ public function setSealDocumentsWithTabsOnly($seal_documents_with_tabs_only) /** * Gets seal_name + * * @return string */ public function getSealName() @@ -192,7 +258,9 @@ public function getSealName() /** * Sets seal_name + * * @param string $seal_name + * * @return $this */ public function setSealName($seal_name) @@ -204,6 +272,7 @@ public function setSealName($seal_name) /** * Gets signature_provider_name + * * @return string */ public function getSignatureProviderName() @@ -213,7 +282,9 @@ public function getSignatureProviderName() /** * Sets signature_provider_name + * * @param string $signature_provider_name + * * @return $this */ public function setSignatureProviderName($signature_provider_name) @@ -225,6 +296,7 @@ public function setSignatureProviderName($signature_provider_name) /** * Gets signature_provider_options + * * @return \DocuSign\eSign\Model\RecipientSignatureProviderOptions */ public function getSignatureProviderOptions() @@ -234,7 +306,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) @@ -245,7 +319,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) @@ -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/RecipientSignatureProviderOptions.php b/src/Model/RecipientSignatureProviderOptions.php index a1c2fc07..179830c8 100644 --- a/src/Model/RecipientSignatureProviderOptions.php +++ b/src/Model/RecipientSignatureProviderOptions.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ class RecipientSignatureProviderOptions implements ArrayAccess 'sms' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'cpf_number' => null, + 'one_time_password' => null, + 'signer_role' => null, + 'sms' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'sms' => 'sms' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'sms' => 'setSms' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'sms' => 'getSms' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 cpf_number + * * @return string */ public function getCpfNumber() @@ -171,7 +234,9 @@ public function getCpfNumber() /** * Sets cpf_number + * * @param string $cpf_number + * * @return $this */ public function setCpfNumber($cpf_number) @@ -183,6 +248,7 @@ public function setCpfNumber($cpf_number) /** * Gets one_time_password + * * @return string */ public function getOneTimePassword() @@ -192,7 +258,9 @@ public function getOneTimePassword() /** * Sets one_time_password + * * @param string $one_time_password + * * @return $this */ public function setOneTimePassword($one_time_password) @@ -204,6 +272,7 @@ public function setOneTimePassword($one_time_password) /** * Gets signer_role + * * @return string */ public function getSignerRole() @@ -213,7 +282,9 @@ public function getSignerRole() /** * Sets signer_role + * * @param string $signer_role + * * @return $this */ public function setSignerRole($signer_role) @@ -225,6 +296,7 @@ public function setSignerRole($signer_role) /** * Gets sms + * * @return string */ public function getSms() @@ -234,7 +306,9 @@ public function getSms() /** * Sets sms + * * @param string $sms + * * @return $this */ public function setSms($sms) @@ -245,7 +319,9 @@ public function setSms($sms) } /** * 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/RecipientUpdateResponse.php b/src/Model/RecipientUpdateResponse.php index 9c02e607..77e90e11 100644 --- a/src/Model/RecipientUpdateResponse.php +++ b/src/Model/RecipientUpdateResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -59,13 +62,41 @@ class RecipientUpdateResponse implements ArrayAccess 'tabs' => '\DocuSign\eSign\Model\Tabs' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'error_details' => null, + 'recipient_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 = [ @@ -74,9 +105,9 @@ public static function swaggerTypes() 'tabs' => 'tabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -85,9 +116,9 @@ public static function swaggerTypes() 'tabs' => 'setTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -96,34 +127,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) { @@ -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 recipient_id + * * @return string */ public function getRecipientId() @@ -187,7 +252,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) @@ -199,6 +266,7 @@ public function setRecipientId($recipient_id) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -208,7 +276,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) @@ -219,7 +289,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) @@ -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/RecipientViewRequest.php b/src/Model/RecipientViewRequest.php index c411307f..369fd62b 100644 --- a/src/Model/RecipientViewRequest.php +++ b/src/Model/RecipientViewRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 729d4193..9fc3f9ea 100644 --- a/src/Model/Recipients.php +++ b/src/Model/Recipients.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ed08f192..9478eafb 100644 --- a/src/Model/RecipientsUpdateSummary.php +++ b/src/Model/RecipientsUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 42a3311e..5a97feab 100644 --- a/src/Model/ReferralInformation.php +++ b/src/Model/ReferralInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a31c2431..a8d8f5c1 100644 --- a/src/Model/Reminders.php +++ b/src/Model/Reminders.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 cc4de35a..12133e80 100644 --- a/src/Model/ResourceInformation.php +++ b/src/Model/ResourceInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 d78f12a8..7f26d94b 100644 --- a/src/Model/ReturnUrlRequest.php +++ b/src/Model/ReturnUrlRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/SamlAssertionAttribute.php b/src/Model/SamlAssertionAttribute.php index 675288b9..784aba0e 100644 --- a/src/Model/SamlAssertionAttribute.php +++ b/src/Model/SamlAssertionAttribute.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * + * Swagger Codegen version: 2.4.13-SNAPSHOT */ /** @@ -30,6 +30,7 @@ namespace DocuSign\eSign\Model; use \ArrayAccess; +use \DocuSign\eSign\ObjectSerializer; /** * SamlAssertionAttribute Class Doc Comment @@ -39,18 +40,20 @@ * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ -class SamlAssertionAttribute implements ArrayAccess +class SamlAssertionAttribute implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. + * * @var string */ protected static $swaggerModelName = 'samlAssertionAttribute'; /** * Array of property to type mappings. Used for (de)serialization + * * @var string[] */ protected static $swaggerTypes = [ @@ -60,13 +63,42 @@ class SamlAssertionAttribute 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 + * * @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 associated with the named SAML assertion attribute + * * @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/SealIdentifier.php b/src/Model/SealIdentifier.php index 17935413..04dc86d5 100644 --- a/src/Model/SealIdentifier.php +++ b/src/Model/SealIdentifier.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 4b88eb7d..7232b00d 100644 --- a/src/Model/SealSign.php +++ b/src/Model/SealSign.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -69,6 +72,7 @@ class SealSign implements ArrayAccess 'fax_number' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'identity_verification' => '\DocuSign\eSign\Model\RecipientIdentityVerification', 'inherit_email_notification_configuration' => 'string', 'name' => 'string', 'note' => 'string', @@ -94,13 +98,77 @@ 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, + 'add_access_code_to_email' => null, + 'client_user_id' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email_notification' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'fax_number' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'name' => null, + 'note' => null, + 'phone_authentication' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'require_id_lookup' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signed_date_time' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -119,6 +187,7 @@ public static function swaggerTypes() 'fax_number' => 'faxNumber', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', + 'identity_verification' => 'identityVerification', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'name' => 'name', 'note' => 'note', @@ -144,9 +213,9 @@ public static function swaggerTypes() 'user_id' => 'userId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -165,6 +234,7 @@ public static function swaggerTypes() 'fax_number' => 'setFaxNumber', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', + 'identity_verification' => 'setIdentityVerification', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'name' => 'setName', 'note' => 'setNote', @@ -190,9 +260,9 @@ public static function swaggerTypes() 'user_id' => 'setUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -211,6 +281,7 @@ public static function swaggerTypes() 'fax_number' => 'getFaxNumber', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', + 'identity_verification' => 'getIdentityVerification', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'name' => 'getName', 'note' => 'getNote', @@ -236,34 +307,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) { @@ -282,6 +382,7 @@ public function __construct(array $data = null) $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['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['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; @@ -308,30 +409,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -341,7 +444,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) @@ -353,6 +458,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -362,7 +468,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) @@ -374,6 +482,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -383,7 +492,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) @@ -395,6 +506,7 @@ public function setClientUserId($client_user_id) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -404,7 +516,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) @@ -416,6 +530,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -425,7 +540,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) @@ -437,6 +554,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -446,7 +564,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) @@ -458,6 +578,7 @@ public function setDeclinedReason($declined_reason) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -467,7 +588,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) @@ -479,6 +602,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -488,7 +612,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -500,6 +626,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -509,7 +636,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -521,6 +650,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -530,7 +660,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) @@ -542,6 +674,7 @@ public function setEmailNotification($email_notification) /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -551,7 +684,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) @@ -563,6 +698,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -572,7 +708,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) @@ -584,6 +722,7 @@ public function setErrorDetails($error_details) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -593,7 +732,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -605,6 +746,7 @@ public function setFaxNumber($fax_number) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -614,7 +756,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) @@ -626,6 +770,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -635,7 +780,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) @@ -645,8 +792,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() @@ -656,7 +828,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) @@ -668,6 +842,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets name + * * @return string */ public function getName() @@ -677,7 +852,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -689,6 +866,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -698,7 +876,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) @@ -710,6 +890,7 @@ public function setNote($note) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -719,7 +900,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) @@ -731,6 +914,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -740,7 +924,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -752,6 +938,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -761,7 +948,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) @@ -773,6 +962,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -782,7 +972,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) @@ -794,6 +986,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -803,7 +996,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -815,6 +1010,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -824,7 +1020,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -836,6 +1034,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -845,7 +1044,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) @@ -857,6 +1058,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -866,7 +1068,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -878,6 +1082,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -887,7 +1092,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) @@ -899,6 +1106,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -908,7 +1116,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -920,6 +1130,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -929,7 +1140,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) @@ -941,6 +1154,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -950,7 +1164,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) @@ -962,6 +1178,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -971,7 +1188,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) @@ -983,6 +1202,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -992,7 +1212,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) @@ -1004,6 +1226,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1013,7 +1236,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) @@ -1025,6 +1250,7 @@ public function setStatus($status) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1034,7 +1260,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) @@ -1046,6 +1274,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1055,7 +1284,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) @@ -1067,6 +1298,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1076,7 +1308,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) @@ -1088,6 +1322,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1097,7 +1332,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1109,6 +1346,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1118,7 +1356,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1129,7 +1369,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) @@ -1139,7 +1381,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1149,8 +1393,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1164,7 +1410,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1174,16 +1422,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 38919def..3393c704 100644 --- a/src/Model/SeatDiscount.php +++ b/src/Model/SeatDiscount.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 7976475d..64fa82f2 100644 --- a/src/Model/SenderEmailNotifications.php +++ b/src/Model/SenderEmailNotifications.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -65,13 +68,47 @@ 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, + '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 = [ @@ -86,9 +123,9 @@ public static function swaggerTypes() 'withdrawn_consent' => 'withdrawnConsent' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -103,9 +140,9 @@ public static function swaggerTypes() 'withdrawn_consent' => 'setWithdrawnConsent' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -120,34 +157,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) { @@ -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 changed_signer + * * @return string */ public function getChangedSigner() @@ -196,7 +264,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) @@ -208,6 +278,7 @@ public function setChangedSigner($changed_signer) /** * Gets comments_only_private_and_mention + * * @return string */ public function getCommentsOnlyPrivateAndMention() @@ -217,7 +288,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) @@ -229,6 +302,7 @@ public function setCommentsOnlyPrivateAndMention($comments_only_private_and_ment /** * Gets comments_receive_all + * * @return string */ public function getCommentsReceiveAll() @@ -238,7 +312,9 @@ public function getCommentsReceiveAll() /** * Sets comments_receive_all + * * @param string $comments_receive_all + * * @return $this */ public function setCommentsReceiveAll($comments_receive_all) @@ -250,6 +326,7 @@ public function setCommentsReceiveAll($comments_receive_all) /** * Gets delivery_failed + * * @return string */ public function getDeliveryFailed() @@ -259,7 +336,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) @@ -271,6 +350,7 @@ public function setDeliveryFailed($delivery_failed) /** * Gets envelope_complete + * * @return string */ public function getEnvelopeComplete() @@ -280,7 +360,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) @@ -292,6 +374,7 @@ public function setEnvelopeComplete($envelope_complete) /** * Gets offline_signing_failed + * * @return string */ public function getOfflineSigningFailed() @@ -301,7 +384,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) @@ -313,6 +398,7 @@ public function setOfflineSigningFailed($offline_signing_failed) /** * Gets recipient_viewed + * * @return string */ public function getRecipientViewed() @@ -322,7 +408,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) @@ -334,6 +422,7 @@ public function setRecipientViewed($recipient_viewed) /** * Gets sender_envelope_declined + * * @return string */ public function getSenderEnvelopeDeclined() @@ -343,7 +432,9 @@ public function getSenderEnvelopeDeclined() /** * Sets sender_envelope_declined + * * @param string $sender_envelope_declined + * * @return $this */ public function setSenderEnvelopeDeclined($sender_envelope_declined) @@ -355,6 +446,7 @@ public function setSenderEnvelopeDeclined($sender_envelope_declined) /** * Gets withdrawn_consent + * * @return string */ public function getWithdrawnConsent() @@ -364,7 +456,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) @@ -375,7 +469,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) @@ -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/ServerTemplate.php b/src/Model/ServerTemplate.php index 402136d1..3612e136 100644 --- a/src/Model/ServerTemplate.php +++ b/src/Model/ServerTemplate.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 453520bb..c06cce07 100644 --- a/src/Model/ServiceInformation.php +++ b/src/Model/ServiceInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 43c17427..e601df37 100644 --- a/src/Model/ServiceVersion.php +++ b/src/Model/ServiceVersion.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 c673c23f..15952192 100644 --- a/src/Model/SettingsMetadata.php +++ b/src/Model/SettingsMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 7790ab47..c3e5ce38 100644 --- a/src/Model/SharedItem.php +++ b/src/Model/SharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 04e17b9c..5b28c2da 100644 --- a/src/Model/SignHere.php +++ b/src/Model/SignHere.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -87,13 +90,69 @@ class SignHere implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'merge_field' => null, + 'name' => null, + 'optional' => null, + 'page_number' => null, + 'recipient_id' => null, + 'scale_value' => 'float', + 'stamp_type' => null, + 'stamp_type_metadata' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -130,9 +189,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -169,9 +228,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -208,34 +267,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) { @@ -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 anchor_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -306,7 +396,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) @@ -318,6 +410,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -327,7 +420,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) @@ -339,6 +434,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -348,7 +444,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) @@ -360,6 +458,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -369,7 +468,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) @@ -381,6 +482,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -390,7 +492,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) @@ -402,6 +506,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -411,7 +516,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) @@ -423,6 +530,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -432,7 +540,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) @@ -444,6 +554,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -453,7 +564,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) @@ -465,6 +578,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -474,7 +588,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) @@ -486,6 +602,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -495,7 +612,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) @@ -507,6 +626,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -516,7 +636,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) @@ -528,6 +650,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -537,7 +660,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) @@ -549,6 +674,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -558,7 +684,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) @@ -570,6 +698,7 @@ public function setErrorDetails($error_details) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -579,7 +708,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) @@ -591,6 +722,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -600,7 +732,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -612,6 +746,7 @@ public function setName($name) /** * Gets optional + * * @return string */ public function getOptional() @@ -621,7 +756,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -633,6 +770,7 @@ public function setOptional($optional) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -642,7 +780,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) @@ -654,6 +794,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -663,7 +804,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) @@ -675,6 +818,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value + * * @return float */ public function getScaleValue() @@ -684,7 +828,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param float $scale_value + * * @return $this */ public function setScaleValue($scale_value) @@ -696,6 +842,7 @@ public function setScaleValue($scale_value) /** * Gets stamp_type + * * @return string */ public function getStampType() @@ -705,7 +852,9 @@ public function getStampType() /** * Sets stamp_type + * * @param string $stamp_type + * * @return $this */ public function setStampType($stamp_type) @@ -717,6 +866,7 @@ public function setStampType($stamp_type) /** * Gets stamp_type_metadata + * * @return \DocuSign\eSign\Model\PropertyMetadata */ public function getStampTypeMetadata() @@ -726,7 +876,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) @@ -738,6 +890,7 @@ public function setStampTypeMetadata($stamp_type_metadata) /** * Gets status + * * @return string */ public function getStatus() @@ -747,7 +900,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) @@ -759,6 +914,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -768,7 +924,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -780,6 +938,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -789,7 +948,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) @@ -801,6 +962,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -810,7 +972,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) @@ -822,6 +986,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -831,7 +996,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -843,6 +1010,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -852,7 +1020,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) @@ -864,6 +1034,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -873,7 +1044,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) @@ -885,6 +1058,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -894,7 +1068,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -906,6 +1082,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -915,7 +1092,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) @@ -927,6 +1106,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -936,7 +1116,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) @@ -947,7 +1129,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) @@ -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/SignatureProviderRequiredOption.php b/src/Model/SignatureProviderRequiredOption.php index eb855955..c6d33a07 100644 --- a/src/Model/SignatureProviderRequiredOption.php +++ b/src/Model/SignatureProviderRequiredOption.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3ce48200..5e4b5ad3 100644 --- a/src/Model/SignatureType.php +++ b/src/Model/SignatureType.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 749a6c81..383efe81 100644 --- a/src/Model/Signer.php +++ b/src/Model/Signer.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -119,13 +122,101 @@ 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, + 'add_access_code_to_email' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'auto_navigation' => null, + 'bulk_recipients_uri' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'is_bulk_recipient' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'require_id_lookup' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'sign_in_each_location' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -194,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 = [ @@ -265,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 = [ @@ -336,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) { @@ -433,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() @@ -466,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) @@ -478,6 +602,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -487,7 +612,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) @@ -499,6 +626,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -508,7 +636,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -520,6 +650,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -529,7 +660,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -541,6 +674,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -550,7 +684,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -562,6 +698,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets bulk_recipients_uri + * * @return string */ public function getBulkRecipientsUri() @@ -571,7 +708,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) @@ -583,6 +722,7 @@ public function setBulkRecipientsUri($bulk_recipients_uri) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -592,7 +732,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) @@ -604,6 +746,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -613,7 +756,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) @@ -625,6 +770,7 @@ public function setClientUserId($client_user_id) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -634,7 +780,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -646,6 +794,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -655,7 +804,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) @@ -667,6 +818,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -676,7 +828,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) @@ -688,6 +842,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -697,7 +852,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) @@ -709,6 +866,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -718,7 +876,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -730,6 +890,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -739,7 +900,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) @@ -751,6 +914,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -760,7 +924,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -772,6 +938,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -781,7 +948,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -793,6 +962,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -802,7 +972,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 +986,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -823,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) @@ -835,6 +1010,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -844,7 +1020,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -856,6 +1034,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -865,7 +1044,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 +1058,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -886,7 +1068,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 +1082,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -907,7 +1092,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 +1106,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -928,7 +1116,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -940,6 +1130,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -949,7 +1140,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) @@ -961,6 +1154,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -970,7 +1164,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -982,6 +1178,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -991,7 +1188,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) @@ -1003,6 +1202,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1012,7 +1212,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) @@ -1024,6 +1226,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1033,7 +1236,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) @@ -1045,6 +1250,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1054,7 +1260,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) @@ -1066,6 +1274,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets is_bulk_recipient + * * @return string */ public function getIsBulkRecipient() @@ -1075,7 +1284,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) @@ -1087,6 +1298,7 @@ public function setIsBulkRecipient($is_bulk_recipient) /** * Gets last_name + * * @return string */ public function getLastName() @@ -1096,7 +1308,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1108,6 +1322,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -1117,7 +1332,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1129,6 +1346,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -1138,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) @@ -1150,6 +1370,7 @@ public function setNote($note) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1159,7 +1380,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) @@ -1171,6 +1394,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1180,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) @@ -1192,6 +1418,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1201,7 +1428,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) @@ -1213,6 +1442,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1222,7 +1452,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1234,6 +1466,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1243,7 +1476,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) @@ -1255,6 +1490,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1264,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) @@ -1276,6 +1514,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1285,7 +1524,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1297,6 +1538,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1306,7 +1548,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1318,6 +1562,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1327,7 +1572,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1339,6 +1586,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1348,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) @@ -1360,6 +1610,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1369,7 +1620,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) @@ -1381,6 +1634,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1390,7 +1644,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) @@ -1402,6 +1658,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1411,7 +1668,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1423,6 +1682,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1432,7 +1692,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) @@ -1444,6 +1706,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1453,7 +1716,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1465,6 +1730,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1474,7 +1740,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) @@ -1486,6 +1754,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -1495,7 +1764,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) @@ -1507,6 +1778,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1516,7 +1788,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) @@ -1528,6 +1802,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -1537,7 +1812,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) @@ -1549,6 +1826,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1558,7 +1836,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) @@ -1570,6 +1850,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1579,7 +1860,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) @@ -1591,6 +1874,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1600,7 +1884,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) @@ -1612,6 +1898,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1621,7 +1908,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) @@ -1633,6 +1922,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1642,7 +1932,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) @@ -1654,6 +1946,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1663,7 +1956,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) @@ -1675,6 +1970,7 @@ public function setStatus($status) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1684,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) @@ -1696,6 +1994,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1705,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) @@ -1717,6 +2018,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1726,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) @@ -1738,6 +2042,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1747,7 +2052,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1759,6 +2066,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1768,7 +2076,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1779,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) @@ -1789,7 +2101,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1799,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) @@ -1814,7 +2130,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1824,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/SignerAttachment.php b/src/Model/SignerAttachment.php index bade473c..de8223e5 100644 --- a/src/Model/SignerAttachment.php +++ b/src/Model/SignerAttachment.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -85,13 +88,67 @@ class SignerAttachment implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'merge_field' => null, + 'name' => null, + 'optional' => null, + 'page_number' => null, + 'recipient_id' => null, + 'scale_value' => 'float', + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -126,9 +183,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -163,9 +220,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -200,34 +257,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) { @@ -263,30 +349,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -296,7 +384,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) @@ -308,6 +398,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -317,7 +408,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) @@ -329,6 +422,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -338,7 +432,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) @@ -350,6 +446,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -359,7 +456,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) @@ -371,6 +470,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -380,7 +480,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) @@ -392,6 +494,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -401,7 +504,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) @@ -413,6 +518,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -422,7 +528,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) @@ -434,6 +542,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -443,7 +552,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) @@ -455,6 +566,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -464,7 +576,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) @@ -476,6 +590,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -485,7 +600,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) @@ -497,6 +614,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -506,7 +624,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) @@ -518,6 +638,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -527,7 +648,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) @@ -539,6 +662,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -548,7 +672,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) @@ -560,6 +686,7 @@ public function setErrorDetails($error_details) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -569,7 +696,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) @@ -581,6 +710,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -590,7 +720,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -602,6 +734,7 @@ public function setName($name) /** * Gets optional + * * @return string */ public function getOptional() @@ -611,7 +744,9 @@ public function getOptional() /** * Sets optional + * * @param string $optional + * * @return $this */ public function setOptional($optional) @@ -623,6 +758,7 @@ public function setOptional($optional) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -632,7 +768,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) @@ -644,6 +782,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -653,7 +792,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) @@ -665,6 +806,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value + * * @return float */ public function getScaleValue() @@ -674,7 +816,9 @@ public function getScaleValue() /** * Sets scale_value + * * @param float $scale_value + * * @return $this */ public function setScaleValue($scale_value) @@ -686,6 +830,7 @@ public function setScaleValue($scale_value) /** * Gets status + * * @return string */ public function getStatus() @@ -695,7 +840,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) @@ -707,6 +854,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -716,7 +864,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -728,6 +878,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -737,7 +888,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) @@ -749,6 +902,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -758,7 +912,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) @@ -770,6 +926,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -779,7 +936,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -791,6 +950,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -800,7 +960,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) @@ -812,6 +974,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -821,7 +984,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) @@ -833,6 +998,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -842,7 +1008,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -854,6 +1022,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -863,7 +1032,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) @@ -875,6 +1046,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -884,7 +1056,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) @@ -895,7 +1069,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) @@ -905,7 +1081,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -915,8 +1093,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -930,7 +1110,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -940,16 +1122,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 60966bb5..9f5ad594 100644 --- a/src/Model/SignerEmailNotifications.php +++ b/src/Model/SignerEmailNotifications.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 eb5880d8..d395b85d 100644 --- a/src/Model/SigningGroup.php +++ b/src/Model/SigningGroup.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 8bb64355..cd5c2fbd 100644 --- a/src/Model/SigningGroupInformation.php +++ b/src/Model/SigningGroupInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0316ef58..24e1139d 100644 --- a/src/Model/SigningGroupUser.php +++ b/src/Model/SigningGroupUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e9ff1f41..730785cd 100644 --- a/src/Model/SigningGroupUsers.php +++ b/src/Model/SigningGroupUsers.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/SmartSection.php b/src/Model/SmartSection.php index 009ee298..602a4efa 100644 --- a/src/Model/SmartSection.php +++ b/src/Model/SmartSection.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -89,13 +92,71 @@ class SmartSection implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'case_sensitive' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'display_settings' => null, + 'document_id' => null, + 'end_anchor' => null, + 'end_position' => null, + 'error_details' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'remove_end_anchor' => null, + 'remove_start_anchor' => null, + 'start_anchor' => null, + 'start_position' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => 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 = [ @@ -134,9 +195,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -175,9 +236,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -216,34 +277,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) { @@ -283,30 +373,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -316,7 +408,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) @@ -328,6 +422,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -337,7 +432,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) @@ -349,6 +446,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -358,7 +456,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) @@ -370,6 +470,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -379,7 +480,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) @@ -391,6 +494,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -400,7 +504,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) @@ -412,6 +518,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -421,7 +528,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) @@ -433,6 +542,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -442,7 +552,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) @@ -454,6 +566,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -463,7 +576,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) @@ -475,6 +590,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets case_sensitive + * * @return bool */ public function getCaseSensitive() @@ -484,7 +600,9 @@ public function getCaseSensitive() /** * Sets case_sensitive + * * @param bool $case_sensitive + * * @return $this */ public function setCaseSensitive($case_sensitive) @@ -496,6 +614,7 @@ public function setCaseSensitive($case_sensitive) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -505,7 +624,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) @@ -517,6 +638,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -526,7 +648,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) @@ -538,6 +662,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -547,7 +672,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) @@ -559,6 +686,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets display_settings + * * @return \DocuSign\eSign\Model\SmartSectionDisplaySettings */ public function getDisplaySettings() @@ -568,7 +696,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) @@ -580,6 +710,7 @@ public function setDisplaySettings($display_settings) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -589,7 +720,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) @@ -601,6 +734,7 @@ public function setDocumentId($document_id) /** * Gets end_anchor + * * @return string */ public function getEndAnchor() @@ -610,7 +744,9 @@ public function getEndAnchor() /** * Sets end_anchor + * * @param string $end_anchor + * * @return $this */ public function setEndAnchor($end_anchor) @@ -622,6 +758,7 @@ public function setEndAnchor($end_anchor) /** * Gets end_position + * * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition */ public function getEndPosition() @@ -631,7 +768,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) @@ -643,6 +782,7 @@ public function setEndPosition($end_position) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -652,7 +792,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) @@ -664,6 +806,7 @@ public function setErrorDetails($error_details) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -673,7 +816,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) @@ -685,6 +830,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -694,7 +840,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) @@ -706,6 +854,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -715,7 +864,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) @@ -727,6 +878,7 @@ public function setRecipientId($recipient_id) /** * Gets remove_end_anchor + * * @return bool */ public function getRemoveEndAnchor() @@ -736,7 +888,9 @@ public function getRemoveEndAnchor() /** * Sets remove_end_anchor + * * @param bool $remove_end_anchor + * * @return $this */ public function setRemoveEndAnchor($remove_end_anchor) @@ -748,6 +902,7 @@ public function setRemoveEndAnchor($remove_end_anchor) /** * Gets remove_start_anchor + * * @return bool */ public function getRemoveStartAnchor() @@ -757,7 +912,9 @@ public function getRemoveStartAnchor() /** * Sets remove_start_anchor + * * @param bool $remove_start_anchor + * * @return $this */ public function setRemoveStartAnchor($remove_start_anchor) @@ -769,6 +926,7 @@ public function setRemoveStartAnchor($remove_start_anchor) /** * Gets start_anchor + * * @return string */ public function getStartAnchor() @@ -778,7 +936,9 @@ public function getStartAnchor() /** * Sets start_anchor + * * @param string $start_anchor + * * @return $this */ public function setStartAnchor($start_anchor) @@ -790,6 +950,7 @@ public function setStartAnchor($start_anchor) /** * Gets start_position + * * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition */ public function getStartPosition() @@ -799,7 +960,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) @@ -811,6 +974,7 @@ public function setStartPosition($start_position) /** * Gets status + * * @return string */ public function getStatus() @@ -820,7 +984,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) @@ -832,6 +998,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -841,7 +1008,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -853,6 +1022,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -862,7 +1032,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) @@ -874,6 +1046,7 @@ public function setTabId($tab_id) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -883,7 +1056,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -895,6 +1070,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -904,7 +1080,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) @@ -916,6 +1094,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -925,7 +1104,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) @@ -937,6 +1118,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -946,7 +1128,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -958,6 +1142,7 @@ public function setTooltip($tooltip) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -967,7 +1152,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) @@ -979,6 +1166,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -988,7 +1176,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) @@ -999,7 +1189,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) @@ -1009,7 +1201,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1019,8 +1213,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1034,7 +1230,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1044,16 +1242,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 136ea322..c271f283 100644 --- a/src/Model/SmartSectionAnchorPosition.php +++ b/src/Model/SmartSectionAnchorPosition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0313080f..8180da0e 100644 --- a/src/Model/SmartSectionCollapsibleDisplaySettings.php +++ b/src/Model/SmartSectionCollapsibleDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6960327f..2e34fe67 100644 --- a/src/Model/SmartSectionDisplaySettings.php +++ b/src/Model/SmartSectionDisplaySettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ecca102f..6f2639c3 100644 --- a/src/Model/SocialAccountInformation.php +++ b/src/Model/SocialAccountInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3c8620f6..2039e788 100644 --- a/src/Model/SocialAuthentication.php +++ b/src/Model/SocialAuthentication.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5c433d88..ddc1c991 100644 --- a/src/Model/Ssn.php +++ b/src/Model/Ssn.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -103,13 +106,85 @@ class Ssn implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -162,9 +237,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -217,9 +292,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -272,34 +347,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) { @@ -353,30 +457,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -386,7 +492,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) @@ -398,6 +506,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -407,7 +516,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) @@ -419,6 +530,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -428,7 +540,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) @@ -440,6 +554,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -449,7 +564,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) @@ -461,6 +578,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -470,7 +588,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) @@ -482,6 +602,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -491,7 +612,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) @@ -503,6 +626,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -512,7 +636,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) @@ -524,6 +650,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -533,7 +660,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) @@ -545,6 +674,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -554,7 +684,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) @@ -566,6 +698,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -575,7 +708,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) @@ -587,6 +722,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -596,7 +732,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) @@ -608,6 +746,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -617,7 +756,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) @@ -629,6 +770,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -638,7 +780,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) @@ -650,6 +794,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -659,7 +804,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) @@ -671,6 +818,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -680,7 +828,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) @@ -692,6 +842,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -701,7 +852,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) @@ -713,6 +866,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -722,7 +876,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) @@ -734,6 +890,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -743,7 +900,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) @@ -755,6 +914,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -764,7 +924,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) @@ -776,6 +938,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -785,7 +948,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) @@ -797,6 +962,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -806,7 +972,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) @@ -818,6 +986,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -827,7 +996,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -839,6 +1010,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -848,7 +1020,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) @@ -860,6 +1034,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -869,7 +1044,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -881,6 +1058,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -890,7 +1068,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) @@ -902,6 +1082,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -911,7 +1092,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) @@ -923,6 +1106,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -932,7 +1116,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) @@ -944,6 +1130,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -953,7 +1140,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) @@ -965,6 +1154,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -974,7 +1164,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) @@ -986,6 +1178,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -995,7 +1188,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) @@ -1007,6 +1202,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1016,7 +1212,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) @@ -1028,6 +1226,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1037,7 +1236,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1049,6 +1250,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1058,7 +1260,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) @@ -1070,6 +1274,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1079,7 +1284,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1091,6 +1298,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1100,7 +1308,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) @@ -1112,6 +1322,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1121,7 +1332,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) @@ -1133,6 +1346,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1142,7 +1356,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1154,6 +1370,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1163,7 +1380,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) @@ -1175,6 +1394,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1184,7 +1404,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) @@ -1196,6 +1418,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1205,7 +1428,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1217,6 +1442,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1226,7 +1452,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) @@ -1238,6 +1466,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1247,7 +1476,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) @@ -1259,6 +1490,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1268,7 +1500,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) @@ -1280,6 +1514,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1289,7 +1524,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1301,6 +1538,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1310,7 +1548,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1322,6 +1562,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1331,7 +1572,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) @@ -1343,6 +1586,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1352,7 +1596,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) @@ -1363,7 +1609,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) @@ -1373,7 +1621,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1383,8 +1633,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1398,7 +1650,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1408,16 +1662,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 4f07db03..2c4d4f74 100644 --- a/src/Model/Ssn4InformationInput.php +++ b/src/Model/Ssn4InformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 045874d1..58e1bcc1 100644 --- a/src/Model/Ssn9InformationInput.php +++ b/src/Model/Ssn9InformationInput.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/SupportedLanguages.php b/src/Model/SupportedLanguages.php index 3fdfd419..a6e0538e 100644 --- a/src/Model/SupportedLanguages.php +++ b/src/Model/SupportedLanguages.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3dd633b8..14460239 100644 --- a/src/Model/TabAccountSettings.php +++ b/src/Model/TabAccountSettings.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -94,13 +97,76 @@ 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, + 'checkbox_tabs_metadata' => null, + 'data_field_regex_enabled' => null, + 'data_field_regex_metadata' => null, + 'data_field_size_enabled' => null, + 'data_field_size_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 = [ @@ -144,9 +210,9 @@ public static function swaggerTypes() 'text_tabs_metadata' => 'textTabsMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -190,9 +256,9 @@ public static function swaggerTypes() 'text_tabs_metadata' => 'setTextTabsMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -236,34 +302,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) { @@ -308,30 +403,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -341,7 +438,9 @@ public function getAllowTabOrder() /** * Sets allow_tab_order + * * @param string $allow_tab_order + * * @return $this */ public function setAllowTabOrder($allow_tab_order) @@ -353,6 +452,7 @@ public function setAllowTabOrder($allow_tab_order) /** * Gets allow_tab_order_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getAllowTabOrderMetadata() @@ -362,7 +462,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) @@ -374,6 +476,7 @@ public function setAllowTabOrderMetadata($allow_tab_order_metadata) /** * Gets approve_decline_tabs_enabled + * * @return string */ public function getApproveDeclineTabsEnabled() @@ -383,7 +486,9 @@ public function getApproveDeclineTabsEnabled() /** * Sets approve_decline_tabs_enabled + * * @param string $approve_decline_tabs_enabled + * * @return $this */ public function setApproveDeclineTabsEnabled($approve_decline_tabs_enabled) @@ -395,6 +500,7 @@ public function setApproveDeclineTabsEnabled($approve_decline_tabs_enabled) /** * Gets approve_decline_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getApproveDeclineTabsMetadata() @@ -404,7 +510,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) @@ -416,6 +524,7 @@ public function setApproveDeclineTabsMetadata($approve_decline_tabs_metadata) /** * Gets calculated_fields_enabled + * * @return string */ public function getCalculatedFieldsEnabled() @@ -425,7 +534,9 @@ public function getCalculatedFieldsEnabled() /** * Sets calculated_fields_enabled + * * @param string $calculated_fields_enabled + * * @return $this */ public function setCalculatedFieldsEnabled($calculated_fields_enabled) @@ -437,6 +548,7 @@ public function setCalculatedFieldsEnabled($calculated_fields_enabled) /** * Gets calculated_fields_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCalculatedFieldsMetadata() @@ -446,7 +558,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) @@ -458,6 +572,7 @@ public function setCalculatedFieldsMetadata($calculated_fields_metadata) /** * Gets checkbox_tabs_enabled + * * @return string */ public function getCheckboxTabsEnabled() @@ -467,7 +582,9 @@ public function getCheckboxTabsEnabled() /** * Sets checkbox_tabs_enabled + * * @param string $checkbox_tabs_enabled + * * @return $this */ public function setCheckboxTabsEnabled($checkbox_tabs_enabled) @@ -479,6 +596,7 @@ public function setCheckboxTabsEnabled($checkbox_tabs_enabled) /** * Gets checkbox_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCheckboxTabsMetadata() @@ -488,7 +606,9 @@ public function getCheckboxTabsMetadata() /** * Sets checkbox_tabs_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $checkbox_tabs_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $checkbox_tabs_metadata checkbox_tabs_metadata + * * @return $this */ public function setCheckboxTabsMetadata($checkbox_tabs_metadata) @@ -500,6 +620,7 @@ public function setCheckboxTabsMetadata($checkbox_tabs_metadata) /** * Gets data_field_regex_enabled + * * @return string */ public function getDataFieldRegexEnabled() @@ -509,7 +630,9 @@ public function getDataFieldRegexEnabled() /** * Sets data_field_regex_enabled + * * @param string $data_field_regex_enabled + * * @return $this */ public function setDataFieldRegexEnabled($data_field_regex_enabled) @@ -521,6 +644,7 @@ public function setDataFieldRegexEnabled($data_field_regex_enabled) /** * Gets data_field_regex_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDataFieldRegexMetadata() @@ -530,7 +654,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) @@ -542,6 +668,7 @@ public function setDataFieldRegexMetadata($data_field_regex_metadata) /** * Gets data_field_size_enabled + * * @return string */ public function getDataFieldSizeEnabled() @@ -551,7 +678,9 @@ public function getDataFieldSizeEnabled() /** * Sets data_field_size_enabled + * * @param string $data_field_size_enabled + * * @return $this */ public function setDataFieldSizeEnabled($data_field_size_enabled) @@ -563,6 +692,7 @@ public function setDataFieldSizeEnabled($data_field_size_enabled) /** * Gets data_field_size_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getDataFieldSizeMetadata() @@ -572,7 +702,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) @@ -584,6 +716,7 @@ public function setDataFieldSizeMetadata($data_field_size_metadata) /** * Gets first_last_email_tabs_enabled + * * @return string */ public function getFirstLastEmailTabsEnabled() @@ -593,7 +726,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) @@ -605,6 +740,7 @@ public function setFirstLastEmailTabsEnabled($first_last_email_tabs_enabled) /** * Gets first_last_email_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getFirstLastEmailTabsMetadata() @@ -614,7 +750,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) @@ -626,6 +764,7 @@ public function setFirstLastEmailTabsMetadata($first_last_email_tabs_metadata) /** * Gets list_tabs_enabled + * * @return string */ public function getListTabsEnabled() @@ -635,7 +774,9 @@ public function getListTabsEnabled() /** * Sets list_tabs_enabled + * * @param string $list_tabs_enabled + * * @return $this */ public function setListTabsEnabled($list_tabs_enabled) @@ -647,6 +788,7 @@ public function setListTabsEnabled($list_tabs_enabled) /** * Gets list_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getListTabsMetadata() @@ -656,7 +798,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) @@ -668,6 +812,7 @@ public function setListTabsMetadata($list_tabs_metadata) /** * Gets note_tabs_enabled + * * @return string */ public function getNoteTabsEnabled() @@ -677,7 +822,9 @@ public function getNoteTabsEnabled() /** * Sets note_tabs_enabled + * * @param string $note_tabs_enabled + * * @return $this */ public function setNoteTabsEnabled($note_tabs_enabled) @@ -689,6 +836,7 @@ public function setNoteTabsEnabled($note_tabs_enabled) /** * Gets note_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getNoteTabsMetadata() @@ -698,7 +846,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) @@ -710,6 +860,7 @@ public function setNoteTabsMetadata($note_tabs_metadata) /** * Gets radio_tabs_enabled + * * @return string */ public function getRadioTabsEnabled() @@ -719,7 +870,9 @@ public function getRadioTabsEnabled() /** * Sets radio_tabs_enabled + * * @param string $radio_tabs_enabled + * * @return $this */ public function setRadioTabsEnabled($radio_tabs_enabled) @@ -731,6 +884,7 @@ public function setRadioTabsEnabled($radio_tabs_enabled) /** * Gets radio_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getRadioTabsMetadata() @@ -740,7 +894,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) @@ -752,6 +908,7 @@ public function setRadioTabsMetadata($radio_tabs_metadata) /** * Gets saving_custom_tabs_enabled + * * @return string */ public function getSavingCustomTabsEnabled() @@ -761,7 +918,9 @@ public function getSavingCustomTabsEnabled() /** * Sets saving_custom_tabs_enabled + * * @param string $saving_custom_tabs_enabled + * * @return $this */ public function setSavingCustomTabsEnabled($saving_custom_tabs_enabled) @@ -773,6 +932,7 @@ public function setSavingCustomTabsEnabled($saving_custom_tabs_enabled) /** * Gets saving_custom_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSavingCustomTabsMetadata() @@ -782,7 +942,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) @@ -794,6 +956,7 @@ public function setSavingCustomTabsMetadata($saving_custom_tabs_metadata) /** * Gets sender_to_change_tab_assignments_enabled + * * @return string */ public function getSenderToChangeTabAssignmentsEnabled() @@ -803,7 +966,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) @@ -815,6 +980,7 @@ public function setSenderToChangeTabAssignmentsEnabled($sender_to_change_tab_ass /** * Gets sender_to_change_tab_assignments_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSenderToChangeTabAssignmentsMetadata() @@ -824,7 +990,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) @@ -836,6 +1004,7 @@ public function setSenderToChangeTabAssignmentsMetadata($sender_to_change_tab_as /** * Gets shared_custom_tabs_enabled + * * @return string */ public function getSharedCustomTabsEnabled() @@ -845,7 +1014,9 @@ public function getSharedCustomTabsEnabled() /** * Sets shared_custom_tabs_enabled + * * @param string $shared_custom_tabs_enabled + * * @return $this */ public function setSharedCustomTabsEnabled($shared_custom_tabs_enabled) @@ -857,6 +1028,7 @@ public function setSharedCustomTabsEnabled($shared_custom_tabs_enabled) /** * Gets shared_custom_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getSharedCustomTabsMetadata() @@ -866,7 +1038,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) @@ -878,6 +1052,7 @@ public function setSharedCustomTabsMetadata($shared_custom_tabs_metadata) /** * Gets tab_data_label_enabled + * * @return string */ public function getTabDataLabelEnabled() @@ -887,7 +1062,9 @@ public function getTabDataLabelEnabled() /** * Sets tab_data_label_enabled + * * @param string $tab_data_label_enabled + * * @return $this */ public function setTabDataLabelEnabled($tab_data_label_enabled) @@ -899,6 +1076,7 @@ public function setTabDataLabelEnabled($tab_data_label_enabled) /** * Gets tab_data_label_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabDataLabelMetadata() @@ -908,7 +1086,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) @@ -920,6 +1100,7 @@ public function setTabDataLabelMetadata($tab_data_label_metadata) /** * Gets tab_location_enabled + * * @return string */ public function getTabLocationEnabled() @@ -929,7 +1110,9 @@ public function getTabLocationEnabled() /** * Sets tab_location_enabled + * * @param string $tab_location_enabled + * * @return $this */ public function setTabLocationEnabled($tab_location_enabled) @@ -941,6 +1124,7 @@ public function setTabLocationEnabled($tab_location_enabled) /** * Gets tab_location_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabLocationMetadata() @@ -950,7 +1134,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) @@ -962,6 +1148,7 @@ public function setTabLocationMetadata($tab_location_metadata) /** * Gets tab_locking_enabled + * * @return string */ public function getTabLockingEnabled() @@ -971,7 +1158,9 @@ public function getTabLockingEnabled() /** * Sets tab_locking_enabled + * * @param string $tab_locking_enabled + * * @return $this */ public function setTabLockingEnabled($tab_locking_enabled) @@ -983,6 +1172,7 @@ public function setTabLockingEnabled($tab_locking_enabled) /** * Gets tab_locking_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabLockingMetadata() @@ -992,7 +1182,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) @@ -1004,6 +1196,7 @@ public function setTabLockingMetadata($tab_locking_metadata) /** * Gets tab_scale_enabled + * * @return string */ public function getTabScaleEnabled() @@ -1013,7 +1206,9 @@ public function getTabScaleEnabled() /** * Sets tab_scale_enabled + * * @param string $tab_scale_enabled + * * @return $this */ public function setTabScaleEnabled($tab_scale_enabled) @@ -1025,6 +1220,7 @@ public function setTabScaleEnabled($tab_scale_enabled) /** * Gets tab_scale_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabScaleMetadata() @@ -1034,7 +1230,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) @@ -1046,6 +1244,7 @@ public function setTabScaleMetadata($tab_scale_metadata) /** * Gets tab_text_formatting_enabled + * * @return string */ public function getTabTextFormattingEnabled() @@ -1055,7 +1254,9 @@ public function getTabTextFormattingEnabled() /** * Sets tab_text_formatting_enabled + * * @param string $tab_text_formatting_enabled + * * @return $this */ public function setTabTextFormattingEnabled($tab_text_formatting_enabled) @@ -1067,6 +1268,7 @@ public function setTabTextFormattingEnabled($tab_text_formatting_enabled) /** * Gets tab_text_formatting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTabTextFormattingMetadata() @@ -1076,7 +1278,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) @@ -1088,6 +1292,7 @@ public function setTabTextFormattingMetadata($tab_text_formatting_metadata) /** * Gets text_tabs_enabled + * * @return string */ public function getTextTabsEnabled() @@ -1097,7 +1302,9 @@ public function getTextTabsEnabled() /** * Sets text_tabs_enabled + * * @param string $text_tabs_enabled + * * @return $this */ public function setTextTabsEnabled($text_tabs_enabled) @@ -1109,6 +1316,7 @@ public function setTextTabsEnabled($text_tabs_enabled) /** * Gets text_tabs_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getTextTabsMetadata() @@ -1118,7 +1326,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) @@ -1129,7 +1339,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) @@ -1139,7 +1351,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1149,8 +1363,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1164,7 +1380,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1174,16 +1392,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 7983b040..3195418c 100644 --- a/src/Model/TabMetadata.php +++ b/src/Model/TabMetadata.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 75996881..a02a503b 100644 --- a/src/Model/TabMetadataList.php +++ b/src/Model/TabMetadataList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 ebd5fe76..c463f7e5 100644 --- a/src/Model/Tabs.php +++ b/src/Model/Tabs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -83,13 +86,65 @@ 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, + 'company_tabs' => null, + 'date_signed_tabs' => null, + 'date_tabs' => null, + 'decline_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, + 'radio_group_tabs' => null, + 'signer_attachment_tabs' => null, + 'sign_here_tabs' => null, + 'smart_section_tabs' => null, + 'ssn_tabs' => 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 = [ @@ -122,9 +177,9 @@ public static function swaggerTypes() 'zip_tabs' => 'zipTabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -157,9 +212,9 @@ public static function swaggerTypes() 'zip_tabs' => 'setZipTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -192,34 +247,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) { @@ -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 approve_tabs + * * @return \DocuSign\eSign\Model\Approve[] */ public function getApproveTabs() @@ -286,7 +372,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) @@ -298,6 +386,7 @@ public function setApproveTabs($approve_tabs) /** * Gets checkbox_tabs + * * @return \DocuSign\eSign\Model\Checkbox[] */ public function getCheckboxTabs() @@ -307,7 +396,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) @@ -319,6 +410,7 @@ public function setCheckboxTabs($checkbox_tabs) /** * Gets company_tabs + * * @return \DocuSign\eSign\Model\Company[] */ public function getCompanyTabs() @@ -328,7 +420,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) @@ -340,6 +434,7 @@ public function setCompanyTabs($company_tabs) /** * Gets date_signed_tabs + * * @return \DocuSign\eSign\Model\DateSigned[] */ public function getDateSignedTabs() @@ -349,7 +444,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) @@ -361,6 +458,7 @@ public function setDateSignedTabs($date_signed_tabs) /** * Gets date_tabs + * * @return \DocuSign\eSign\Model\\DateTime[] */ public function getDateTabs() @@ -370,7 +468,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) @@ -382,6 +482,7 @@ public function setDateTabs($date_tabs) /** * Gets decline_tabs + * * @return \DocuSign\eSign\Model\Decline[] */ public function getDeclineTabs() @@ -391,7 +492,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) @@ -403,6 +506,7 @@ public function setDeclineTabs($decline_tabs) /** * Gets email_address_tabs + * * @return \DocuSign\eSign\Model\EmailAddress[] */ public function getEmailAddressTabs() @@ -412,7 +516,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) @@ -424,6 +530,7 @@ public function setEmailAddressTabs($email_address_tabs) /** * Gets email_tabs + * * @return \DocuSign\eSign\Model\Email[] */ public function getEmailTabs() @@ -433,7 +540,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) @@ -445,6 +554,7 @@ public function setEmailTabs($email_tabs) /** * Gets envelope_id_tabs + * * @return \DocuSign\eSign\Model\EnvelopeId[] */ public function getEnvelopeIdTabs() @@ -454,7 +564,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) @@ -466,6 +578,7 @@ public function setEnvelopeIdTabs($envelope_id_tabs) /** * Gets first_name_tabs + * * @return \DocuSign\eSign\Model\FirstName[] */ public function getFirstNameTabs() @@ -475,7 +588,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) @@ -487,6 +602,7 @@ public function setFirstNameTabs($first_name_tabs) /** * Gets formula_tabs + * * @return \DocuSign\eSign\Model\FormulaTab[] */ public function getFormulaTabs() @@ -496,7 +612,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) @@ -508,6 +626,7 @@ public function setFormulaTabs($formula_tabs) /** * Gets full_name_tabs + * * @return \DocuSign\eSign\Model\FullName[] */ public function getFullNameTabs() @@ -517,7 +636,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) @@ -529,6 +650,7 @@ public function setFullNameTabs($full_name_tabs) /** * Gets initial_here_tabs + * * @return \DocuSign\eSign\Model\InitialHere[] */ public function getInitialHereTabs() @@ -538,7 +660,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) @@ -550,6 +674,7 @@ public function setInitialHereTabs($initial_here_tabs) /** * Gets last_name_tabs + * * @return \DocuSign\eSign\Model\LastName[] */ public function getLastNameTabs() @@ -559,7 +684,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) @@ -571,6 +698,7 @@ public function setLastNameTabs($last_name_tabs) /** * Gets list_tabs + * * @return \DocuSign\eSign\Model\array[] */ public function getListTabs() @@ -580,7 +708,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) @@ -592,6 +722,7 @@ public function setListTabs($list_tabs) /** * Gets notarize_tabs + * * @return \DocuSign\eSign\Model\Notarize[] */ public function getNotarizeTabs() @@ -601,7 +732,9 @@ public function getNotarizeTabs() /** * Sets notarize_tabs + * * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * * @return $this */ public function setNotarizeTabs($notarize_tabs) @@ -613,6 +746,7 @@ public function setNotarizeTabs($notarize_tabs) /** * Gets note_tabs + * * @return \DocuSign\eSign\Model\Note[] */ public function getNoteTabs() @@ -622,7 +756,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) @@ -634,6 +770,7 @@ public function setNoteTabs($note_tabs) /** * Gets number_tabs + * * @return \DocuSign\eSign\Model\Number[] */ public function getNumberTabs() @@ -643,7 +780,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) @@ -655,6 +794,7 @@ public function setNumberTabs($number_tabs) /** * Gets radio_group_tabs + * * @return \DocuSign\eSign\Model\RadioGroup[] */ public function getRadioGroupTabs() @@ -664,7 +804,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) @@ -676,6 +818,7 @@ public function setRadioGroupTabs($radio_group_tabs) /** * Gets signer_attachment_tabs + * * @return \DocuSign\eSign\Model\SignerAttachment[] */ public function getSignerAttachmentTabs() @@ -685,7 +828,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) @@ -697,6 +842,7 @@ public function setSignerAttachmentTabs($signer_attachment_tabs) /** * Gets sign_here_tabs + * * @return \DocuSign\eSign\Model\SignHere[] */ public function getSignHereTabs() @@ -706,7 +852,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) @@ -718,6 +866,7 @@ public function setSignHereTabs($sign_here_tabs) /** * Gets smart_section_tabs + * * @return \DocuSign\eSign\Model\SmartSection[] */ public function getSmartSectionTabs() @@ -727,7 +876,9 @@ public function getSmartSectionTabs() /** * Sets smart_section_tabs + * * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * * @return $this */ public function setSmartSectionTabs($smart_section_tabs) @@ -739,6 +890,7 @@ public function setSmartSectionTabs($smart_section_tabs) /** * Gets ssn_tabs + * * @return \DocuSign\eSign\Model\Ssn[] */ public function getSsnTabs() @@ -748,7 +900,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) @@ -760,6 +914,7 @@ public function setSsnTabs($ssn_tabs) /** * Gets text_tabs + * * @return \DocuSign\eSign\Model\Text[] */ public function getTextTabs() @@ -769,7 +924,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) @@ -781,6 +938,7 @@ public function setTextTabs($text_tabs) /** * Gets title_tabs + * * @return \DocuSign\eSign\Model\Title[] */ public function getTitleTabs() @@ -790,7 +948,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) @@ -802,6 +962,7 @@ public function setTitleTabs($title_tabs) /** * Gets view_tabs + * * @return \DocuSign\eSign\Model\View[] */ public function getViewTabs() @@ -811,7 +972,9 @@ public function getViewTabs() /** * Sets view_tabs + * * @param \DocuSign\eSign\Model\View[] $view_tabs + * * @return $this */ public function setViewTabs($view_tabs) @@ -823,6 +986,7 @@ public function setViewTabs($view_tabs) /** * Gets zip_tabs + * * @return \DocuSign\eSign\Model\Zip[] */ public function getZipTabs() @@ -832,7 +996,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) @@ -843,7 +1009,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) @@ -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/TemplateCustomFields.php b/src/Model/TemplateCustomFields.php index 6afd81d2..d34d1724 100644 --- a/src/Model/TemplateCustomFields.php +++ b/src/Model/TemplateCustomFields.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 3d9f1dc9..6e694800 100644 --- a/src/Model/TemplateDocumentVisibilityList.php +++ b/src/Model/TemplateDocumentVisibilityList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 1e7571eb..ed71c6bb 100644 --- a/src/Model/TemplateDocumentsResult.php +++ b/src/Model/TemplateDocumentsResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 42439a34..ee0753e5 100644 --- a/src/Model/TemplateInformation.php +++ b/src/Model/TemplateInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 e3f204ce..7171b542 100644 --- a/src/Model/TemplateMatch.php +++ b/src/Model/TemplateMatch.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 673de38b..122fa320 100644 --- a/src/Model/TemplateNotificationRequest.php +++ b/src/Model/TemplateNotificationRequest.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 f782d68f..a1a0a4ab 100644 --- a/src/Model/TemplateRecipients.php +++ b/src/Model/TemplateRecipients.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 32b9954b..ce4f2650 100644 --- a/src/Model/TemplateRole.php +++ b/src/Model/TemplateRole.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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.<br/><br/>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 179a9986..41ad6d9b 100644 --- a/src/Model/TemplateSharedItem.php +++ b/src/Model/TemplateSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -63,13 +66,45 @@ 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, + '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 = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'template_name' => 'templateName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'template_name' => 'setTemplateName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,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) { @@ -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 owner + * * @return \DocuSign\eSign\Model\UserInfo */ public function getOwner() @@ -207,7 +276,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) @@ -219,6 +290,7 @@ public function setOwner($owner) /** * Gets shared + * * @return string */ public function getShared() @@ -228,7 +300,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -240,6 +314,7 @@ public function setShared($shared) /** * Gets shared_groups + * * @return \DocuSign\eSign\Model\MemberGroupSharedItem[] */ public function getSharedGroups() @@ -249,7 +324,9 @@ public function getSharedGroups() /** * Sets shared_groups + * * @param \DocuSign\eSign\Model\MemberGroupSharedItem[] $shared_groups + * * @return $this */ public function setSharedGroups($shared_groups) @@ -261,6 +338,7 @@ public function setSharedGroups($shared_groups) /** * Gets shared_users + * * @return \DocuSign\eSign\Model\UserSharedItem[] */ public function getSharedUsers() @@ -270,7 +348,9 @@ public function getSharedUsers() /** * Sets shared_users + * * @param \DocuSign\eSign\Model\UserSharedItem[] $shared_users + * * @return $this */ public function setSharedUsers($shared_users) @@ -282,6 +362,7 @@ public function setSharedUsers($shared_users) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -291,7 +372,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) @@ -303,6 +386,7 @@ public function setTemplateId($template_id) /** * Gets template_name + * * @return string */ public function getTemplateName() @@ -312,7 +396,9 @@ public function getTemplateName() /** * Sets template_name + * * @param string $template_name + * * @return $this */ public function setTemplateName($template_name) @@ -323,7 +409,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) @@ -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/TemplateSummary.php b/src/Model/TemplateSummary.php index 2db172a9..f381ec03 100644 --- a/src/Model/TemplateSummary.php +++ b/src/Model/TemplateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -63,13 +66,45 @@ 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, + '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 = [ @@ -82,9 +117,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -97,9 +132,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -112,34 +147,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) { @@ -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 applied + * * @return string */ public function getApplied() @@ -186,7 +252,9 @@ public function getApplied() /** * Sets applied + * * @param string $applied Reserved: TBD + * * @return $this */ public function setApplied($applied) @@ -198,6 +266,7 @@ public function setApplied($applied) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -207,7 +276,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) @@ -219,6 +290,7 @@ public function setDocumentId($document_id) /** * Gets document_name + * * @return string */ public function getDocumentName() @@ -228,7 +300,9 @@ public function getDocumentName() /** * Sets document_name + * * @param string $document_name + * * @return $this */ public function setDocumentName($document_name) @@ -240,6 +314,7 @@ public function setDocumentName($document_name) /** * Gets name + * * @return string */ public function getName() @@ -249,7 +324,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -261,6 +338,7 @@ public function setName($name) /** * Gets template_id + * * @return string */ public function getTemplateId() @@ -270,7 +348,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) @@ -282,6 +362,7 @@ public function setTemplateId($template_id) /** * Gets template_match + * * @return \DocuSign\eSign\Model\TemplateMatch */ public function getTemplateMatch() @@ -291,7 +372,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) @@ -303,6 +386,7 @@ public function setTemplateMatch($template_match) /** * Gets uri + * * @return string */ public function getUri() @@ -312,7 +396,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -323,7 +409,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) @@ -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/TemplateTabs.php b/src/Model/TemplateTabs.php index 1b9c8a84..0fba1ebf 100644 --- a/src/Model/TemplateTabs.php +++ b/src/Model/TemplateTabs.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -83,13 +86,65 @@ 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, + 'company_tabs' => null, + 'date_signed_tabs' => null, + 'date_tabs' => null, + 'decline_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, + 'radio_group_tabs' => null, + 'signer_attachment_tabs' => null, + 'sign_here_tabs' => null, + 'smart_section_tabs' => null, + 'ssn_tabs' => 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 = [ @@ -122,9 +177,9 @@ public static function swaggerTypes() 'zip_tabs' => 'zipTabs' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -157,9 +212,9 @@ public static function swaggerTypes() 'zip_tabs' => 'setZipTabs' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -192,34 +247,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) { @@ -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 approve_tabs + * * @return \DocuSign\eSign\Model\Approve[] */ public function getApproveTabs() @@ -286,7 +372,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) @@ -298,6 +386,7 @@ public function setApproveTabs($approve_tabs) /** * Gets checkbox_tabs + * * @return \DocuSign\eSign\Model\Checkbox[] */ public function getCheckboxTabs() @@ -307,7 +396,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) @@ -319,6 +410,7 @@ public function setCheckboxTabs($checkbox_tabs) /** * Gets company_tabs + * * @return \DocuSign\eSign\Model\Company[] */ public function getCompanyTabs() @@ -328,7 +420,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) @@ -340,6 +434,7 @@ public function setCompanyTabs($company_tabs) /** * Gets date_signed_tabs + * * @return \DocuSign\eSign\Model\DateSigned[] */ public function getDateSignedTabs() @@ -349,7 +444,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) @@ -361,6 +458,7 @@ public function setDateSignedTabs($date_signed_tabs) /** * Gets date_tabs + * * @return \DocuSign\eSign\Model\\DateTime[] */ public function getDateTabs() @@ -370,7 +468,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) @@ -382,6 +482,7 @@ public function setDateTabs($date_tabs) /** * Gets decline_tabs + * * @return \DocuSign\eSign\Model\Decline[] */ public function getDeclineTabs() @@ -391,7 +492,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) @@ -403,6 +506,7 @@ public function setDeclineTabs($decline_tabs) /** * Gets email_address_tabs + * * @return \DocuSign\eSign\Model\EmailAddress[] */ public function getEmailAddressTabs() @@ -412,7 +516,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) @@ -424,6 +530,7 @@ public function setEmailAddressTabs($email_address_tabs) /** * Gets email_tabs + * * @return \DocuSign\eSign\Model\Email[] */ public function getEmailTabs() @@ -433,7 +540,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) @@ -445,6 +554,7 @@ public function setEmailTabs($email_tabs) /** * Gets envelope_id_tabs + * * @return \DocuSign\eSign\Model\EnvelopeId[] */ public function getEnvelopeIdTabs() @@ -454,7 +564,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) @@ -466,6 +578,7 @@ public function setEnvelopeIdTabs($envelope_id_tabs) /** * Gets first_name_tabs + * * @return \DocuSign\eSign\Model\FirstName[] */ public function getFirstNameTabs() @@ -475,7 +588,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) @@ -487,6 +602,7 @@ public function setFirstNameTabs($first_name_tabs) /** * Gets formula_tabs + * * @return \DocuSign\eSign\Model\FormulaTab[] */ public function getFormulaTabs() @@ -496,7 +612,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) @@ -508,6 +626,7 @@ public function setFormulaTabs($formula_tabs) /** * Gets full_name_tabs + * * @return \DocuSign\eSign\Model\FullName[] */ public function getFullNameTabs() @@ -517,7 +636,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) @@ -529,6 +650,7 @@ public function setFullNameTabs($full_name_tabs) /** * Gets initial_here_tabs + * * @return \DocuSign\eSign\Model\InitialHere[] */ public function getInitialHereTabs() @@ -538,7 +660,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) @@ -550,6 +674,7 @@ public function setInitialHereTabs($initial_here_tabs) /** * Gets last_name_tabs + * * @return \DocuSign\eSign\Model\LastName[] */ public function getLastNameTabs() @@ -559,7 +684,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) @@ -571,6 +698,7 @@ public function setLastNameTabs($last_name_tabs) /** * Gets list_tabs + * * @return \DocuSign\eSign\Model\array[] */ public function getListTabs() @@ -580,7 +708,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) @@ -592,6 +722,7 @@ public function setListTabs($list_tabs) /** * Gets notarize_tabs + * * @return \DocuSign\eSign\Model\Notarize[] */ public function getNotarizeTabs() @@ -601,7 +732,9 @@ public function getNotarizeTabs() /** * Sets notarize_tabs + * * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * * @return $this */ public function setNotarizeTabs($notarize_tabs) @@ -613,6 +746,7 @@ public function setNotarizeTabs($notarize_tabs) /** * Gets note_tabs + * * @return \DocuSign\eSign\Model\Note[] */ public function getNoteTabs() @@ -622,7 +756,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) @@ -634,6 +770,7 @@ public function setNoteTabs($note_tabs) /** * Gets number_tabs + * * @return \DocuSign\eSign\Model\Number[] */ public function getNumberTabs() @@ -643,7 +780,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) @@ -655,6 +794,7 @@ public function setNumberTabs($number_tabs) /** * Gets radio_group_tabs + * * @return \DocuSign\eSign\Model\RadioGroup[] */ public function getRadioGroupTabs() @@ -664,7 +804,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) @@ -676,6 +818,7 @@ public function setRadioGroupTabs($radio_group_tabs) /** * Gets signer_attachment_tabs + * * @return \DocuSign\eSign\Model\SignerAttachment[] */ public function getSignerAttachmentTabs() @@ -685,7 +828,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) @@ -697,6 +842,7 @@ public function setSignerAttachmentTabs($signer_attachment_tabs) /** * Gets sign_here_tabs + * * @return \DocuSign\eSign\Model\SignHere[] */ public function getSignHereTabs() @@ -706,7 +852,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) @@ -718,6 +866,7 @@ public function setSignHereTabs($sign_here_tabs) /** * Gets smart_section_tabs + * * @return \DocuSign\eSign\Model\SmartSection[] */ public function getSmartSectionTabs() @@ -727,7 +876,9 @@ public function getSmartSectionTabs() /** * Sets smart_section_tabs + * * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * * @return $this */ public function setSmartSectionTabs($smart_section_tabs) @@ -739,6 +890,7 @@ public function setSmartSectionTabs($smart_section_tabs) /** * Gets ssn_tabs + * * @return \DocuSign\eSign\Model\Ssn[] */ public function getSsnTabs() @@ -748,7 +900,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) @@ -760,6 +914,7 @@ public function setSsnTabs($ssn_tabs) /** * Gets text_tabs + * * @return \DocuSign\eSign\Model\Text[] */ public function getTextTabs() @@ -769,7 +924,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) @@ -781,6 +938,7 @@ public function setTextTabs($text_tabs) /** * Gets title_tabs + * * @return \DocuSign\eSign\Model\Title[] */ public function getTitleTabs() @@ -790,7 +948,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) @@ -802,6 +962,7 @@ public function setTitleTabs($title_tabs) /** * Gets view_tabs + * * @return \DocuSign\eSign\Model\View[] */ public function getViewTabs() @@ -811,7 +972,9 @@ public function getViewTabs() /** * Sets view_tabs + * * @param \DocuSign\eSign\Model\View[] $view_tabs + * * @return $this */ public function setViewTabs($view_tabs) @@ -823,6 +986,7 @@ public function setViewTabs($view_tabs) /** * Gets zip_tabs + * * @return \DocuSign\eSign\Model\Zip[] */ public function getZipTabs() @@ -832,7 +996,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) @@ -843,7 +1009,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) @@ -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/TemplateUpdateSummary.php b/src/Model/TemplateUpdateSummary.php index f85b671c..4b4f1f91 100644 --- a/src/Model/TemplateUpdateSummary.php +++ b/src/Model/TemplateUpdateSummary.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -64,13 +67,46 @@ 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, + '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 = [ @@ -84,9 +120,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 = [ @@ -100,9 +136,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 = [ @@ -116,34 +152,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) { @@ -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 bulk_envelope_status + * * @return \DocuSign\eSign\Model\BulkEnvelopeStatus */ public function getBulkEnvelopeStatus() @@ -191,7 +258,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) @@ -203,6 +272,7 @@ public function setBulkEnvelopeStatus($bulk_envelope_status) /** * Gets envelope_id + * * @return string */ public function getEnvelopeId() @@ -212,7 +282,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) @@ -224,6 +296,7 @@ public function setEnvelopeId($envelope_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -233,7 +306,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) @@ -245,6 +320,7 @@ public function setErrorDetails($error_details) /** * Gets list_custom_field_update_results + * * @return \DocuSign\eSign\Model\ListCustomField[] */ public function getListCustomFieldUpdateResults() @@ -254,7 +330,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) @@ -266,6 +344,7 @@ public function setListCustomFieldUpdateResults($list_custom_field_update_result /** * Gets lock_information + * * @return \DocuSign\eSign\Model\LockInformation */ public function getLockInformation() @@ -275,7 +354,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) @@ -287,6 +368,7 @@ public function setLockInformation($lock_information) /** * Gets recipient_update_results + * * @return \DocuSign\eSign\Model\RecipientUpdateResponse[] */ public function getRecipientUpdateResults() @@ -296,7 +378,9 @@ public function getRecipientUpdateResults() /** * Sets recipient_update_results + * * @param \DocuSign\eSign\Model\RecipientUpdateResponse[] $recipient_update_results + * * @return $this */ public function setRecipientUpdateResults($recipient_update_results) @@ -308,6 +392,7 @@ public function setRecipientUpdateResults($recipient_update_results) /** * Gets tab_update_results + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabUpdateResults() @@ -317,7 +402,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) @@ -329,6 +416,7 @@ public function setTabUpdateResults($tab_update_results) /** * Gets text_custom_field_update_results + * * @return \DocuSign\eSign\Model\TextCustomField[] */ public function getTextCustomFieldUpdateResults() @@ -338,7 +426,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) @@ -349,7 +439,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) @@ -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/Text.php b/src/Model/Text.php index 01930922..00b0d4ae 100644 --- a/src/Model/Text.php +++ b/src/Model/Text.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -106,13 +109,88 @@ class Text implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'formula' => null, + 'height' => 'int32', + 'is_payment_amount' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -168,9 +246,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -226,9 +304,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -284,34 +362,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) { @@ -368,30 +475,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -401,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) @@ -413,6 +524,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -422,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) @@ -434,6 +548,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -443,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) @@ -455,6 +572,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -464,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) @@ -476,6 +596,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -485,7 +606,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) @@ -497,6 +620,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -506,7 +630,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) @@ -518,6 +644,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -527,7 +654,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) @@ -539,6 +668,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -548,7 +678,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) @@ -560,6 +692,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -569,7 +702,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) @@ -581,6 +716,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -590,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) @@ -602,6 +740,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -611,7 +750,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) @@ -623,6 +764,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -632,7 +774,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) @@ -644,6 +788,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -653,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) @@ -665,6 +812,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -674,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) @@ -686,6 +836,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -695,7 +846,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) @@ -707,6 +860,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -716,7 +870,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) @@ -728,6 +884,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -737,7 +894,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) @@ -749,6 +908,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -758,7 +918,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) @@ -770,6 +932,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -779,7 +942,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) @@ -791,6 +956,7 @@ public function setFontSize($font_size) /** * Gets formula + * * @return string */ public function getFormula() @@ -800,7 +966,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) @@ -812,6 +980,7 @@ public function setFormula($formula) /** * Gets height + * * @return int */ public function getHeight() @@ -821,7 +990,9 @@ public function getHeight() /** * Sets height + * * @param int $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -833,6 +1004,7 @@ public function setHeight($height) /** * Gets is_payment_amount + * * @return string */ public function getIsPaymentAmount() @@ -842,7 +1014,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) @@ -854,6 +1028,7 @@ public function setIsPaymentAmount($is_payment_amount) /** * Gets italic + * * @return string */ public function getItalic() @@ -863,7 +1038,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) @@ -875,6 +1052,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -884,7 +1062,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) @@ -896,6 +1076,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -905,7 +1086,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -917,6 +1100,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -926,7 +1110,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) @@ -938,6 +1124,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -947,7 +1134,9 @@ public function getName() /** * Sets name + * * @param string $name Specifies the tool tip text for the tab. + * * @return $this */ public function setName($name) @@ -959,6 +1148,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -968,7 +1158,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) @@ -980,6 +1172,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -989,7 +1182,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) @@ -1001,6 +1196,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1010,7 +1206,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) @@ -1022,6 +1220,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -1031,7 +1230,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) @@ -1043,6 +1244,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -1052,7 +1254,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) @@ -1064,6 +1268,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -1073,7 +1278,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) @@ -1085,6 +1292,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1094,7 +1302,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) @@ -1106,6 +1316,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1115,7 +1326,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1127,6 +1340,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1136,7 +1350,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) @@ -1148,6 +1364,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1157,7 +1374,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1169,6 +1388,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1178,7 +1398,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) @@ -1190,6 +1412,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1199,7 +1422,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) @@ -1211,6 +1436,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1220,7 +1446,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1232,6 +1460,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1241,7 +1470,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) @@ -1253,6 +1484,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1262,7 +1494,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) @@ -1274,6 +1508,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1283,7 +1518,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1295,6 +1532,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1304,7 +1542,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) @@ -1316,6 +1556,7 @@ public function setUnderline($underline) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1325,7 +1566,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) @@ -1337,6 +1580,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1346,7 +1590,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) @@ -1358,6 +1604,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1367,7 +1614,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1379,6 +1628,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1388,7 +1638,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1400,6 +1652,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1409,7 +1662,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) @@ -1421,6 +1676,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1430,7 +1686,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) @@ -1441,7 +1699,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) @@ -1451,7 +1711,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1461,8 +1723,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1476,7 +1740,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1486,16 +1752,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 13234913..cc0c03e2 100644 --- a/src/Model/TextCustomField.php +++ b/src/Model/TextCustomField.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5f4801f2..7f646442 100644 --- a/src/Model/Title.php +++ b/src/Model/Title.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -97,13 +100,79 @@ class Title implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'required' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -150,9 +219,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -199,9 +268,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -248,34 +317,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) { @@ -323,30 +421,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -356,7 +456,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) @@ -368,6 +470,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -377,7 +480,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) @@ -389,6 +494,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -398,7 +504,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) @@ -410,6 +518,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -419,7 +528,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) @@ -431,6 +542,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -440,7 +552,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) @@ -452,6 +566,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -461,7 +576,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) @@ -473,6 +590,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -482,7 +600,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) @@ -494,6 +614,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -503,7 +624,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) @@ -515,6 +638,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -524,7 +648,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) @@ -536,6 +662,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -545,7 +672,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) @@ -557,6 +686,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -566,7 +696,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) @@ -578,6 +710,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -587,7 +720,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) @@ -599,6 +734,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -608,7 +744,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) @@ -620,6 +758,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -629,7 +768,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) @@ -641,6 +782,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -650,7 +792,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) @@ -662,6 +806,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -671,7 +816,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) @@ -683,6 +830,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -692,7 +840,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) @@ -704,6 +854,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -713,7 +864,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) @@ -725,6 +878,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -734,7 +888,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) @@ -746,6 +902,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -755,7 +912,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) @@ -767,6 +926,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -776,7 +936,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) @@ -788,6 +950,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -797,7 +960,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -809,6 +974,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -818,7 +984,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) @@ -830,6 +998,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -839,7 +1008,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -851,6 +1022,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -860,7 +1032,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) @@ -872,6 +1046,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -881,7 +1056,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) @@ -893,6 +1070,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -902,7 +1080,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) @@ -914,6 +1094,7 @@ public function setRecipientId($recipient_id) /** * Gets required + * * @return string */ public function getRequired() @@ -923,7 +1104,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) @@ -935,6 +1118,7 @@ public function setRequired($required) /** * Gets status + * * @return string */ public function getStatus() @@ -944,7 +1128,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) @@ -956,6 +1142,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -965,7 +1152,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -977,6 +1166,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -986,7 +1176,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) @@ -998,6 +1190,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1007,7 +1200,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) @@ -1019,6 +1214,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1028,7 +1224,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1040,6 +1238,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1049,7 +1248,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) @@ -1061,6 +1262,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1070,7 +1272,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) @@ -1082,6 +1286,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1091,7 +1296,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1103,6 +1310,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1112,7 +1320,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) @@ -1124,6 +1334,7 @@ public function setUnderline($underline) /** * Gets value + * * @return string */ public function getValue() @@ -1133,7 +1344,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1145,6 +1358,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1154,7 +1368,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1166,6 +1382,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1175,7 +1392,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) @@ -1187,6 +1406,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1196,7 +1416,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) @@ -1207,7 +1429,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) @@ -1217,7 +1441,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1227,8 +1453,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1242,7 +1470,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1252,16 +1482,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 4da0bd66..776f3e13 100644 --- a/src/Model/UsageHistory.php +++ b/src/Model/UsageHistory.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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' => 'int' ]; + /** + * 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' => 'int32', + 'signed_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 = [ @@ -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 int */ public function getSentCount() @@ -214,7 +283,9 @@ public function getSentCount() /** * Sets sent_count + * * @param int $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 int */ public function getSignedCount() @@ -235,7 +307,9 @@ public function getSignedCount() /** * Sets signed_count + * * @param int $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 b914dc20..80af0bd7 100644 --- a/src/Model/UserAccountManagementGranularInformation.php +++ b/src/Model/UserAccountManagementGranularInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -69,16 +72,61 @@ 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', + 'can_view_users_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; + /** + * 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_groups' => null, + 'can_manage_groups_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, + 'can_view_users_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 = [ @@ -97,12 +145,14 @@ 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', + 'can_view_users_metadata' => 'canViewUsersMetadata' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -121,12 +171,14 @@ 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', + 'can_view_users_metadata' => 'setCanViewUsersMetadata' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -145,37 +197,68 @@ 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', + 'can_view_users_metadata' => 'getCanViewUsersMetadata' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated array of property values initializing the model + * + * @param mixed[] $data Associated array of property values + * initializing the model */ public function __construct(array $data = null) { @@ -195,33 +278,37 @@ 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; + $this->container['can_view_users_metadata'] = isset($data['can_view_users_metadata']) ? $data['can_view_users_metadata'] : null; } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -231,7 +318,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) @@ -243,6 +332,7 @@ public function setCanManageAccountSecuritySettings($can_manage_account_security /** * Gets can_manage_account_security_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAccountSecuritySettingsMetadata() @@ -252,7 +342,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) @@ -264,6 +356,7 @@ public function setCanManageAccountSecuritySettingsMetadata($can_manage_account_ /** * Gets can_manage_account_settings + * * @return string */ public function getCanManageAccountSettings() @@ -273,7 +366,9 @@ public function getCanManageAccountSettings() /** * Sets can_manage_account_settings + * * @param string $can_manage_account_settings + * * @return $this */ public function setCanManageAccountSettings($can_manage_account_settings) @@ -285,6 +380,7 @@ public function setCanManageAccountSettings($can_manage_account_settings) /** * Gets can_manage_account_settings_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAccountSettingsMetadata() @@ -294,7 +390,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) @@ -306,6 +404,7 @@ public function setCanManageAccountSettingsMetadata($can_manage_account_settings /** * Gets can_manage_admins + * * @return string */ public function getCanManageAdmins() @@ -315,7 +414,9 @@ public function getCanManageAdmins() /** * Sets can_manage_admins + * * @param string $can_manage_admins + * * @return $this */ public function setCanManageAdmins($can_manage_admins) @@ -327,6 +428,7 @@ public function setCanManageAdmins($can_manage_admins) /** * Gets can_manage_admins_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageAdminsMetadata() @@ -336,7 +438,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) @@ -348,6 +452,7 @@ public function setCanManageAdminsMetadata($can_manage_admins_metadata) /** * Gets can_manage_groups + * * @return string */ public function getCanManageGroups() @@ -357,7 +462,9 @@ public function getCanManageGroups() /** * Sets can_manage_groups + * * @param string $can_manage_groups + * * @return $this */ public function setCanManageGroups($can_manage_groups) @@ -369,6 +476,7 @@ public function setCanManageGroups($can_manage_groups) /** * Gets can_manage_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageGroupsMetadata() @@ -378,7 +486,9 @@ public function getCanManageGroupsMetadata() /** * Sets can_manage_groups_metadata - * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_groups_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_groups_metadata can_manage_groups_metadata + * * @return $this */ public function setCanManageGroupsMetadata($can_manage_groups_metadata) @@ -390,6 +500,7 @@ public function setCanManageGroupsMetadata($can_manage_groups_metadata) /** * Gets can_manage_reporting + * * @return string */ public function getCanManageReporting() @@ -399,7 +510,9 @@ public function getCanManageReporting() /** * Sets can_manage_reporting + * * @param string $can_manage_reporting + * * @return $this */ public function setCanManageReporting($can_manage_reporting) @@ -411,6 +524,7 @@ public function setCanManageReporting($can_manage_reporting) /** * Gets can_manage_reporting_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageReportingMetadata() @@ -420,7 +534,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) @@ -432,6 +548,7 @@ public function setCanManageReportingMetadata($can_manage_reporting_metadata) /** * Gets can_manage_sharing + * * @return string */ public function getCanManageSharing() @@ -441,7 +558,9 @@ public function getCanManageSharing() /** * Sets can_manage_sharing + * * @param string $can_manage_sharing + * * @return $this */ public function setCanManageSharing($can_manage_sharing) @@ -453,6 +572,7 @@ public function setCanManageSharing($can_manage_sharing) /** * Gets can_manage_sharing_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageSharingMetadata() @@ -462,7 +582,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) @@ -474,6 +596,7 @@ public function setCanManageSharingMetadata($can_manage_sharing_metadata) /** * Gets can_manage_signing_groups + * * @return string */ public function getCanManageSigningGroups() @@ -483,7 +606,9 @@ public function getCanManageSigningGroups() /** * Sets can_manage_signing_groups + * * @param string $can_manage_signing_groups + * * @return $this */ public function setCanManageSigningGroups($can_manage_signing_groups) @@ -495,6 +620,7 @@ public function setCanManageSigningGroups($can_manage_signing_groups) /** * Gets can_manage_signing_groups_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageSigningGroupsMetadata() @@ -504,7 +630,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) @@ -516,6 +644,7 @@ public function setCanManageSigningGroupsMetadata($can_manage_signing_groups_met /** * Gets can_manage_users + * * @return string */ public function getCanManageUsers() @@ -525,7 +654,9 @@ public function getCanManageUsers() /** * Sets can_manage_users + * * @param string $can_manage_users + * * @return $this */ public function setCanManageUsers($can_manage_users) @@ -537,6 +668,7 @@ public function setCanManageUsers($can_manage_users) /** * Gets can_manage_users_metadata + * * @return \DocuSign\eSign\Model\SettingsMetadata */ public function getCanManageUsersMetadata() @@ -546,7 +678,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) @@ -555,9 +689,59 @@ 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; + } + + /** + * Gets can_view_users_metadata + * + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getCanViewUsersMetadata() + { + return $this->container['can_view_users_metadata']; + } + + /** + * Sets can_view_users_metadata + * + * @param \DocuSign\eSign\Model\SettingsMetadata $can_view_users_metadata can_view_users_metadata + * + * @return $this + */ + public function setCanViewUsersMetadata($can_view_users_metadata) + { + $this->container['can_view_users_metadata'] = $can_view_users_metadata; + + return $this; + } /** * Returns true if offset exists. False otherwise. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return boolean */ public function offsetExists($offset) @@ -567,7 +751,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -577,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) @@ -592,7 +780,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -602,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/UserInfo.php b/src/Model/UserInfo.php index aa676a14..925305cb 100644 --- a/src/Model/UserInfo.php +++ b/src/Model/UserInfo.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -66,13 +69,48 @@ class UserInfo implements ArrayAccess 'user_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'activation_access_code' => null, + 'email' => null, + 'error_details' => null, + 'login_status' => 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 = [ @@ -88,9 +126,9 @@ public static function swaggerTypes() 'user_type' => 'userType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -106,9 +144,9 @@ public static function swaggerTypes() 'user_type' => 'setUserType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -124,34 +162,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) { @@ -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 activation_access_code + * * @return string */ public function getActivationAccessCode() @@ -201,7 +270,9 @@ public function getActivationAccessCode() /** * Sets activation_access_code + * * @param string $activation_access_code + * * @return $this */ public function setActivationAccessCode($activation_access_code) @@ -213,6 +284,7 @@ public function setActivationAccessCode($activation_access_code) /** * Gets email + * * @return string */ public function getEmail() @@ -222,7 +294,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @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 + * + * @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 login_status + * * @return string */ public function getLoginStatus() @@ -264,7 +342,9 @@ public function getLoginStatus() /** * Sets login_status + * * @param string $login_status + * * @return $this */ public function setLoginStatus($login_status) @@ -276,6 +356,7 @@ public function setLoginStatus($login_status) /** * Gets send_activation_email + * * @return string */ public function getSendActivationEmail() @@ -285,7 +366,9 @@ public function getSendActivationEmail() /** * Sets send_activation_email + * * @param string $send_activation_email + * * @return $this */ public function setSendActivationEmail($send_activation_email) @@ -297,6 +380,7 @@ public function setSendActivationEmail($send_activation_email) /** * Gets uri + * * @return string */ public function getUri() @@ -306,7 +390,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -318,6 +404,7 @@ public function setUri($uri) /** * Gets user_id + * * @return string */ public function getUserId() @@ -327,7 +414,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -339,6 +428,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -348,7 +438,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -360,6 +452,7 @@ public function setUserName($user_name) /** * Gets user_status + * * @return string */ public function getUserStatus() @@ -369,7 +462,9 @@ public function getUserStatus() /** * Sets user_status + * * @param string $user_status + * * @return $this */ public function setUserStatus($user_status) @@ -381,6 +476,7 @@ public function setUserStatus($user_status) /** * Gets user_type + * * @return string */ public function getUserType() @@ -390,7 +486,9 @@ public function getUserType() /** * Sets user_type + * * @param string $user_type + * * @return $this */ public function setUserType($user_type) @@ -401,7 +499,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) @@ -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/UserInfoList.php b/src/Model/UserInfoList.php index 89f1c031..e6b936b4 100644 --- a/src/Model/UserInfoList.php +++ b/src/Model/UserInfoList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 407ff9bc..e3bed7a0 100644 --- a/src/Model/UserInformation.php +++ b/src/Model/UserInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -94,13 +97,76 @@ class UserInformation implements ArrayAccess 'work_address' => '\DocuSign\eSign\Model\AddressInformationV2' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_management_granular' => null, + 'activation_access_code' => null, + 'country_code' => null, + 'created_date_time' => null, + 'custom_settings' => 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, + '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_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 = [ @@ -144,9 +210,9 @@ public static function swaggerTypes() 'work_address' => 'workAddress' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -190,9 +256,9 @@ public static function swaggerTypes() 'work_address' => 'setWorkAddress' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -236,34 +302,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) { @@ -308,30 +403,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -341,7 +438,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) @@ -353,6 +452,7 @@ public function setAccountManagementGranular($account_management_granular) /** * Gets activation_access_code + * * @return string */ public function getActivationAccessCode() @@ -362,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) @@ -374,6 +476,7 @@ public function setActivationAccessCode($activation_access_code) /** * Gets country_code + * * @return string */ public function getCountryCode() @@ -383,7 +486,9 @@ public function getCountryCode() /** * Sets country_code + * * @param string $country_code + * * @return $this */ public function setCountryCode($country_code) @@ -395,6 +500,7 @@ public function setCountryCode($country_code) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -404,7 +510,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) @@ -416,6 +524,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets custom_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getCustomSettings() @@ -425,7 +534,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) @@ -437,6 +548,7 @@ public function setCustomSettings($custom_settings) /** * Gets email + * * @return string */ public function getEmail() @@ -446,7 +558,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -458,6 +572,7 @@ public function setEmail($email) /** * Gets enable_connect_for_user + * * @return string */ public function getEnableConnectForUser() @@ -467,7 +582,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) @@ -479,6 +596,7 @@ public function setEnableConnectForUser($enable_connect_for_user) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -488,7 +606,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) @@ -500,6 +620,7 @@ public function setErrorDetails($error_details) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -509,7 +630,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) @@ -521,6 +644,7 @@ public function setFirstName($first_name) /** * Gets forgotten_password_info + * * @return \DocuSign\eSign\Model\ForgottenPasswordInformation */ public function getForgottenPasswordInfo() @@ -530,7 +654,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) @@ -542,6 +668,7 @@ public function setForgottenPasswordInfo($forgotten_password_info) /** * Gets group_list + * * @return \DocuSign\eSign\Model\Group[] */ public function getGroupList() @@ -551,7 +678,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) @@ -563,6 +692,7 @@ public function setGroupList($group_list) /** * Gets home_address + * * @return \DocuSign\eSign\Model\AddressInformationV2 */ public function getHomeAddress() @@ -572,7 +702,9 @@ public function getHomeAddress() /** * Sets home_address - * @param \DocuSign\eSign\Model\AddressInformationV2 $home_address + * + * @param \DocuSign\eSign\Model\AddressInformationV2 $home_address home_address + * * @return $this */ public function setHomeAddress($home_address) @@ -584,6 +716,7 @@ public function setHomeAddress($home_address) /** * Gets initials_image_uri + * * @return string */ public function getInitialsImageUri() @@ -593,7 +726,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) @@ -605,6 +740,7 @@ public function setInitialsImageUri($initials_image_uri) /** * Gets is_admin + * * @return string */ public function getIsAdmin() @@ -614,7 +750,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) @@ -626,6 +764,7 @@ public function setIsAdmin($is_admin) /** * Gets job_title + * * @return string */ public function getJobTitle() @@ -635,7 +774,9 @@ public function getJobTitle() /** * Sets job_title + * * @param string $job_title + * * @return $this */ public function setJobTitle($job_title) @@ -647,6 +788,7 @@ public function setJobTitle($job_title) /** * Gets last_login + * * @return string */ public function getLastLogin() @@ -656,7 +798,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) @@ -668,6 +812,7 @@ public function setLastLogin($last_login) /** * Gets last_name + * * @return string */ public function getLastName() @@ -677,7 +822,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) @@ -689,6 +836,7 @@ public function setLastName($last_name) /** * Gets login_status + * * @return string */ public function getLoginStatus() @@ -698,7 +846,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) @@ -710,6 +860,7 @@ public function setLoginStatus($login_status) /** * Gets middle_name + * * @return string */ public function getMiddleName() @@ -719,7 +870,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) @@ -731,6 +884,7 @@ public function setMiddleName($middle_name) /** * Gets password + * * @return string */ public function getPassword() @@ -740,7 +894,9 @@ public function getPassword() /** * Sets password + * * @param string $password + * * @return $this */ public function setPassword($password) @@ -752,6 +908,7 @@ public function setPassword($password) /** * Gets password_expiration + * * @return string */ public function getPasswordExpiration() @@ -761,7 +918,9 @@ public function getPasswordExpiration() /** * Sets password_expiration + * * @param string $password_expiration + * * @return $this */ public function setPasswordExpiration($password_expiration) @@ -773,6 +932,7 @@ public function setPasswordExpiration($password_expiration) /** * Gets permission_profile_id + * * @return string */ public function getPermissionProfileId() @@ -782,7 +942,9 @@ public function getPermissionProfileId() /** * Sets permission_profile_id + * * @param string $permission_profile_id + * * @return $this */ public function setPermissionProfileId($permission_profile_id) @@ -794,6 +956,7 @@ public function setPermissionProfileId($permission_profile_id) /** * Gets permission_profile_name + * * @return string */ public function getPermissionProfileName() @@ -803,7 +966,9 @@ public function getPermissionProfileName() /** * Sets permission_profile_name + * * @param string $permission_profile_name + * * @return $this */ public function setPermissionProfileName($permission_profile_name) @@ -815,6 +980,7 @@ public function setPermissionProfileName($permission_profile_name) /** * Gets profile_image_uri + * * @return string */ public function getProfileImageUri() @@ -824,7 +990,9 @@ public function getProfileImageUri() /** * Sets profile_image_uri + * * @param string $profile_image_uri + * * @return $this */ public function setProfileImageUri($profile_image_uri) @@ -836,6 +1004,7 @@ public function setProfileImageUri($profile_image_uri) /** * Gets send_activation_email + * * @return string */ public function getSendActivationEmail() @@ -845,7 +1014,9 @@ public function getSendActivationEmail() /** * Sets send_activation_email + * * @param string $send_activation_email + * * @return $this */ public function setSendActivationEmail($send_activation_email) @@ -857,6 +1028,7 @@ public function setSendActivationEmail($send_activation_email) /** * Gets send_activation_on_invalid_login + * * @return string */ public function getSendActivationOnInvalidLogin() @@ -866,7 +1038,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) @@ -878,6 +1052,7 @@ public function setSendActivationOnInvalidLogin($send_activation_on_invalid_logi /** * Gets signature_image_uri + * * @return string */ public function getSignatureImageUri() @@ -887,7 +1062,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) @@ -899,6 +1076,7 @@ public function setSignatureImageUri($signature_image_uri) /** * Gets subscribe + * * @return string */ public function getSubscribe() @@ -908,7 +1086,9 @@ public function getSubscribe() /** * Sets subscribe + * * @param string $subscribe + * * @return $this */ public function setSubscribe($subscribe) @@ -920,6 +1100,7 @@ public function setSubscribe($subscribe) /** * Gets suffix_name + * * @return string */ public function getSuffixName() @@ -929,7 +1110,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) @@ -941,6 +1124,7 @@ public function setSuffixName($suffix_name) /** * Gets title + * * @return string */ public function getTitle() @@ -950,7 +1134,9 @@ public function getTitle() /** * Sets title + * * @param string $title The title of the user. + * * @return $this */ public function setTitle($title) @@ -962,6 +1148,7 @@ public function setTitle($title) /** * Gets uri + * * @return string */ public function getUri() @@ -971,7 +1158,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -983,6 +1172,7 @@ public function setUri($uri) /** * Gets user_id + * * @return string */ public function getUserId() @@ -992,7 +1182,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1004,6 +1196,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -1013,7 +1206,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -1025,6 +1220,7 @@ public function setUserName($user_name) /** * Gets user_profile_last_modified_date + * * @return string */ public function getUserProfileLastModifiedDate() @@ -1034,7 +1230,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) @@ -1046,6 +1244,7 @@ public function setUserProfileLastModifiedDate($user_profile_last_modified_date) /** * Gets user_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getUserSettings() @@ -1055,7 +1254,9 @@ public function getUserSettings() /** * Sets user_settings + * * @param \DocuSign\eSign\Model\NameValue[] $user_settings The name/value pair information for user settings. These determine the actions that a user can take in the account. The `[ML:userSettings]` are listed and described below. + * * @return $this */ public function setUserSettings($user_settings) @@ -1067,6 +1268,7 @@ public function setUserSettings($user_settings) /** * Gets user_status + * * @return string */ public function getUserStatus() @@ -1076,7 +1278,9 @@ public function getUserStatus() /** * Sets user_status + * * @param string $user_status + * * @return $this */ public function setUserStatus($user_status) @@ -1088,6 +1292,7 @@ public function setUserStatus($user_status) /** * Gets user_type + * * @return string */ public function getUserType() @@ -1097,7 +1302,9 @@ public function getUserType() /** * Sets user_type + * * @param string $user_type + * * @return $this */ public function setUserType($user_type) @@ -1109,6 +1316,7 @@ public function setUserType($user_type) /** * Gets work_address + * * @return \DocuSign\eSign\Model\AddressInformationV2 */ public function getWorkAddress() @@ -1118,7 +1326,9 @@ public function getWorkAddress() /** * Sets work_address - * @param \DocuSign\eSign\Model\AddressInformationV2 $work_address + * + * @param \DocuSign\eSign\Model\AddressInformationV2 $work_address work_address + * * @return $this */ public function setWorkAddress($work_address) @@ -1129,7 +1339,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) @@ -1139,7 +1351,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1149,8 +1363,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1164,7 +1380,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1174,16 +1392,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 4a60d2fa..f508cb5e 100644 --- a/src/Model/UserInformationList.php +++ b/src/Model/UserInformationList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 f912e154..02fe89f4 100644 --- a/src/Model/UserPasswordInformation.php +++ b/src/Model/UserPasswordInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 aba6602d..fcb4bc28 100644 --- a/src/Model/UserPasswordRules.php +++ b/src/Model/UserPasswordRules.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 5e350f92..f38ecaf9 100644 --- a/src/Model/UserProfile.php +++ b/src/Model/UserProfile.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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\AddressInformationV2 */ public function getAddress() @@ -211,7 +282,9 @@ public function getAddress() /** * Sets address - * @param \DocuSign\eSign\Model\AddressInformationV2 $address + * + * @param \DocuSign\eSign\Model\AddressInformationV2 $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 b944dfaa..271d836f 100644 --- a/src/Model/UserSettingsInformation.php +++ b/src/Model/UserSettingsInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ class UserSettingsInformation implements ArrayAccess 'user_settings' => '\DocuSign\eSign\Model\NameValue[]' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'account_management_granular' => null, + 'sender_email_notifications' => null, + 'signer_email_notifications' => null, + 'user_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 = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'user_settings' => 'userSettings' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'user_settings' => 'setUserSettings' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,63 @@ public static function swaggerTypes() 'user_settings' => 'getUserSettings' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 account_management_granular + * * @return \DocuSign\eSign\Model\UserAccountManagementGranularInformation */ public function getAccountManagementGranular() @@ -171,7 +234,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) @@ -183,6 +248,7 @@ public function setAccountManagementGranular($account_management_granular) /** * Gets sender_email_notifications + * * @return \DocuSign\eSign\Model\SenderEmailNotifications */ public function getSenderEmailNotifications() @@ -192,7 +258,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) @@ -204,6 +272,7 @@ public function setSenderEmailNotifications($sender_email_notifications) /** * Gets signer_email_notifications + * * @return \DocuSign\eSign\Model\SignerEmailNotifications */ public function getSignerEmailNotifications() @@ -213,7 +282,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) @@ -225,6 +296,7 @@ public function setSignerEmailNotifications($signer_email_notifications) /** * Gets user_settings + * * @return \DocuSign\eSign\Model\NameValue[] */ public function getUserSettings() @@ -234,7 +306,9 @@ public function getUserSettings() /** * Sets user_settings + * * @param \DocuSign\eSign\Model\NameValue[] $user_settings + * * @return $this */ public function setUserSettings($user_settings) @@ -245,7 +319,9 @@ public function setUserSettings($user_settings) } /** * 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/UserSharedItem.php b/src/Model/UserSharedItem.php index 418ac705..c408df2d 100644 --- a/src/Model/UserSharedItem.php +++ b/src/Model/UserSharedItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 a1bf6ebc..1653cc15 100644 --- a/src/Model/UserSignature.php +++ b/src/Model/UserSignature.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -77,13 +80,59 @@ class UserSignature implements ArrayAccess 'stamp_type' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'adopted_date_time' => null, + 'created_date_time' => null, + 'date_stamp_properties' => null, + 'error_details' => null, + 'external_id' => null, + 'image_type' => null, + 'initials150_image_id' => null, + 'initials_image_uri' => null, + 'is_default' => 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_type' => null, + 'stamp_format' => null, + 'stamp_image_uri' => null, + 'stamp_size_mm' => null, + 'stamp_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 = [ @@ -110,9 +159,9 @@ public static function swaggerTypes() 'stamp_type' => 'stampType' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -139,9 +188,9 @@ public static function swaggerTypes() 'stamp_type' => 'setStampType' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -168,34 +217,63 @@ public static function swaggerTypes() 'stamp_type' => 'getStampType' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 adopted_date_time + * * @return string */ public function getAdoptedDateTime() @@ -256,7 +336,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) @@ -268,6 +350,7 @@ public function setAdoptedDateTime($adopted_date_time) /** * Gets created_date_time + * * @return string */ public function getCreatedDateTime() @@ -277,7 +360,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) @@ -289,6 +374,7 @@ public function setCreatedDateTime($created_date_time) /** * Gets date_stamp_properties + * * @return \DocuSign\eSign\Model\DateStampProperties */ public function getDateStampProperties() @@ -298,7 +384,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) @@ -310,6 +398,7 @@ public function setDateStampProperties($date_stamp_properties) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -319,7 +408,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) @@ -331,6 +422,7 @@ public function setErrorDetails($error_details) /** * Gets external_id + * * @return string */ public function getExternalId() @@ -340,7 +432,9 @@ public function getExternalId() /** * Sets external_id + * * @param string $external_id + * * @return $this */ public function setExternalId($external_id) @@ -352,6 +446,7 @@ public function setExternalId($external_id) /** * Gets image_type + * * @return string */ public function getImageType() @@ -361,7 +456,9 @@ public function getImageType() /** * Sets image_type + * * @param string $image_type + * * @return $this */ public function setImageType($image_type) @@ -373,6 +470,7 @@ public function setImageType($image_type) /** * Gets initials150_image_id + * * @return string */ public function getInitials150ImageId() @@ -382,7 +480,9 @@ public function getInitials150ImageId() /** * Sets initials150_image_id + * * @param string $initials150_image_id + * * @return $this */ public function setInitials150ImageId($initials150_image_id) @@ -394,6 +494,7 @@ public function setInitials150ImageId($initials150_image_id) /** * Gets initials_image_uri + * * @return string */ public function getInitialsImageUri() @@ -403,7 +504,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) @@ -415,6 +518,7 @@ public function setInitialsImageUri($initials_image_uri) /** * Gets is_default + * * @return string */ public function getIsDefault() @@ -424,7 +528,9 @@ public function getIsDefault() /** * Sets is_default + * * @param string $is_default + * * @return $this */ public function setIsDefault($is_default) @@ -436,6 +542,7 @@ public function setIsDefault($is_default) /** * Gets phonetic_name + * * @return string */ public function getPhoneticName() @@ -445,7 +552,9 @@ public function getPhoneticName() /** * Sets phonetic_name + * * @param string $phonetic_name + * * @return $this */ public function setPhoneticName($phonetic_name) @@ -457,6 +566,7 @@ public function setPhoneticName($phonetic_name) /** * Gets signature150_image_id + * * @return string */ public function getSignature150ImageId() @@ -466,7 +576,9 @@ public function getSignature150ImageId() /** * Sets signature150_image_id + * * @param string $signature150_image_id + * * @return $this */ public function setSignature150ImageId($signature150_image_id) @@ -478,6 +590,7 @@ public function setSignature150ImageId($signature150_image_id) /** * Gets signature_font + * * @return string */ public function getSignatureFont() @@ -487,7 +600,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) @@ -499,6 +614,7 @@ public function setSignatureFont($signature_font) /** * Gets signature_id + * * @return string */ public function getSignatureId() @@ -508,7 +624,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) @@ -520,6 +638,7 @@ public function setSignatureId($signature_id) /** * Gets signature_image_uri + * * @return string */ public function getSignatureImageUri() @@ -529,7 +648,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) @@ -541,6 +662,7 @@ public function setSignatureImageUri($signature_image_uri) /** * Gets signature_initials + * * @return string */ public function getSignatureInitials() @@ -550,7 +672,9 @@ public function getSignatureInitials() /** * Sets signature_initials + * * @param string $signature_initials The initials associated with the signature. + * * @return $this */ public function setSignatureInitials($signature_initials) @@ -562,6 +686,7 @@ public function setSignatureInitials($signature_initials) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -571,7 +696,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -583,6 +710,7 @@ public function setSignatureName($signature_name) /** * Gets signature_type + * * @return string */ public function getSignatureType() @@ -592,7 +720,9 @@ public function getSignatureType() /** * Sets signature_type + * * @param string $signature_type + * * @return $this */ public function setSignatureType($signature_type) @@ -604,6 +734,7 @@ public function setSignatureType($signature_type) /** * Gets stamp_format + * * @return string */ public function getStampFormat() @@ -613,7 +744,9 @@ public function getStampFormat() /** * Sets stamp_format + * * @param string $stamp_format + * * @return $this */ public function setStampFormat($stamp_format) @@ -625,6 +758,7 @@ public function setStampFormat($stamp_format) /** * Gets stamp_image_uri + * * @return string */ public function getStampImageUri() @@ -634,7 +768,9 @@ public function getStampImageUri() /** * Sets stamp_image_uri + * * @param string $stamp_image_uri + * * @return $this */ public function setStampImageUri($stamp_image_uri) @@ -646,6 +782,7 @@ public function setStampImageUri($stamp_image_uri) /** * Gets stamp_size_mm + * * @return string */ public function getStampSizeMm() @@ -655,7 +792,9 @@ public function getStampSizeMm() /** * Sets stamp_size_mm + * * @param string $stamp_size_mm + * * @return $this */ public function setStampSizeMm($stamp_size_mm) @@ -667,6 +806,7 @@ public function setStampSizeMm($stamp_size_mm) /** * Gets stamp_type + * * @return string */ public function getStampType() @@ -676,7 +816,9 @@ public function getStampType() /** * Sets stamp_type + * * @param string $stamp_type + * * @return $this */ public function setStampType($stamp_type) @@ -687,7 +829,9 @@ public function setStampType($stamp_type) } /** * 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/UserSignatureDefinition.php b/src/Model/UserSignatureDefinition.php index 7986311f..5835d8e1 100644 --- a/src/Model/UserSignatureDefinition.php +++ b/src/Model/UserSignatureDefinition.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -60,13 +63,42 @@ class UserSignatureDefinition implements ArrayAccess 'signature_name' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'signature_font' => null, + 'signature_id' => 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 = [ @@ -76,9 +108,9 @@ public static function swaggerTypes() 'signature_name' => 'signatureName' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -88,9 +120,9 @@ public static function swaggerTypes() 'signature_name' => 'setSignatureName' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -100,34 +132,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) { @@ -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 signature_font + * * @return string */ public function getSignatureFont() @@ -171,7 +234,9 @@ public function getSignatureFont() /** * Sets signature_font + * * @param string $signature_font + * * @return $this */ public function setSignatureFont($signature_font) @@ -183,6 +248,7 @@ public function setSignatureFont($signature_font) /** * Gets signature_id + * * @return string */ public function getSignatureId() @@ -192,7 +258,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) @@ -204,6 +272,7 @@ public function setSignatureId($signature_id) /** * Gets signature_initials + * * @return string */ public function getSignatureInitials() @@ -213,7 +282,9 @@ public function getSignatureInitials() /** * Sets signature_initials + * * @param string $signature_initials + * * @return $this */ public function setSignatureInitials($signature_initials) @@ -225,6 +296,7 @@ public function setSignatureInitials($signature_initials) /** * Gets signature_name + * * @return string */ public function getSignatureName() @@ -234,7 +306,9 @@ public function getSignatureName() /** * Sets signature_name + * * @param string $signature_name Specifies the user signature name. + * * @return $this */ public function setSignatureName($signature_name) @@ -245,7 +319,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) @@ -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/UserSignaturesInformation.php b/src/Model/UserSignaturesInformation.php index 9ac811af..2758d510 100644 --- a/src/Model/UserSignaturesInformation.php +++ b/src/Model/UserSignaturesInformation.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 438969a0..6966f770 100644 --- a/src/Model/UserSocialIdResult.php +++ b/src/Model/UserSocialIdResult.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 88f144af..050490f0 100644 --- a/src/Model/UsersResponse.php +++ b/src/Model/UsersResponse.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 bf08160e..5b41966a 100644 --- a/src/Model/View.php +++ b/src/Model/View.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -93,13 +96,75 @@ class View implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'button_text' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'height' => 'int32', + 'italic' => null, + 'merge_field' => null, + 'page_number' => null, + 'recipient_id' => null, + 'required' => null, + 'required_read' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'width' => 'int32', + '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 = [ @@ -142,9 +207,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -187,9 +252,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -232,34 +297,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) { @@ -303,30 +397,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -336,7 +432,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) @@ -348,6 +446,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -357,7 +456,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) @@ -369,6 +470,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -378,7 +480,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) @@ -390,6 +494,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -399,7 +504,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) @@ -411,6 +518,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -420,7 +528,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) @@ -432,6 +542,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -441,7 +552,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) @@ -453,6 +566,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -462,7 +576,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) @@ -474,6 +590,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -483,7 +600,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) @@ -495,6 +614,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -504,7 +624,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) @@ -516,6 +638,7 @@ public function setBold($bold) /** * Gets button_text + * * @return string */ public function getButtonText() @@ -525,7 +648,9 @@ public function getButtonText() /** * Sets button_text + * * @param string $button_text + * * @return $this */ public function setButtonText($button_text) @@ -537,6 +662,7 @@ public function setButtonText($button_text) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -546,7 +672,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) @@ -558,6 +686,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -567,7 +696,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) @@ -579,6 +710,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -588,7 +720,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) @@ -600,6 +734,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -609,7 +744,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) @@ -621,6 +758,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -630,7 +768,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) @@ -642,6 +782,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -651,7 +792,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) @@ -663,6 +806,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -672,7 +816,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) @@ -684,6 +830,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -693,7 +840,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) @@ -705,6 +854,7 @@ public function setFontSize($font_size) /** * Gets height + * * @return int */ public function getHeight() @@ -714,7 +864,9 @@ public function getHeight() /** * Sets height + * * @param int $height Height of the tab in pixels. + * * @return $this */ public function setHeight($height) @@ -726,6 +878,7 @@ public function setHeight($height) /** * Gets italic + * * @return string */ public function getItalic() @@ -735,7 +888,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) @@ -747,6 +902,7 @@ public function setItalic($italic) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -756,7 +912,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) @@ -768,6 +926,7 @@ public function setMergeField($merge_field) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -777,7 +936,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) @@ -789,6 +950,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -798,7 +960,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) @@ -810,6 +974,7 @@ public function setRecipientId($recipient_id) /** * Gets required + * * @return string */ public function getRequired() @@ -819,7 +984,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) @@ -831,6 +998,7 @@ public function setRequired($required) /** * Gets required_read + * * @return string */ public function getRequiredRead() @@ -840,7 +1008,9 @@ public function getRequiredRead() /** * Sets required_read + * * @param string $required_read + * * @return $this */ public function setRequiredRead($required_read) @@ -852,6 +1022,7 @@ public function setRequiredRead($required_read) /** * Gets status + * * @return string */ public function getStatus() @@ -861,7 +1032,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) @@ -873,6 +1046,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -882,7 +1056,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -894,6 +1070,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -903,7 +1080,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) @@ -915,6 +1094,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -924,7 +1104,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) @@ -936,6 +1118,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -945,7 +1128,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -957,6 +1142,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -966,7 +1152,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) @@ -978,6 +1166,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -987,7 +1176,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) @@ -999,6 +1190,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1008,7 +1200,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1020,6 +1214,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1029,7 +1224,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) @@ -1041,6 +1238,7 @@ public function setUnderline($underline) /** * Gets width + * * @return int */ public function getWidth() @@ -1050,7 +1248,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1062,6 +1262,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1071,7 +1272,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) @@ -1083,6 +1286,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1092,7 +1296,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) @@ -1103,7 +1309,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) @@ -1113,7 +1321,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1123,8 +1333,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1138,7 +1350,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1148,16 +1362,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 adc5bd23..3c766335 100644 --- a/src/Model/ViewUrl.php +++ b/src/Model/ViewUrl.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 37de879e..95f6136a 100644 --- a/src/Model/Watermark.php +++ b/src/Model/Watermark.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b19c18cc..a9c03b32 100644 --- a/src/Model/Witness.php +++ b/src/Model/Witness.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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,18 +40,20 @@ * @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 = [ @@ -121,13 +124,103 @@ 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, + 'add_access_code_to_email' => null, + 'agent_can_edit_email' => null, + 'agent_can_edit_name' => null, + 'auto_navigation' => null, + 'bulk_recipients_uri' => null, + 'can_sign_offline' => null, + 'client_user_id' => null, + 'creation_reason' => null, + 'custom_fields' => null, + 'declined_date_time' => null, + 'declined_reason' => null, + 'default_recipient' => null, + 'delivered_date_time' => null, + 'delivery_method' => null, + 'document_visibility' => null, + 'email' => null, + 'email_notification' => null, + 'email_recipient_post_signing_url' => null, + 'embedded_recipient_start_url' => null, + 'error_details' => null, + 'excluded_documents' => null, + 'fax_number' => null, + 'first_name' => null, + 'full_name' => null, + 'id_check_configuration_name' => null, + 'id_check_information_input' => null, + 'identity_verification' => null, + 'inherit_email_notification_configuration' => null, + 'is_bulk_recipient' => null, + 'last_name' => null, + 'name' => null, + 'note' => null, + 'offline_attributes' => null, + 'phone_authentication' => null, + 'proof_file' => null, + 'recipient_attachments' => null, + 'recipient_authentication_status' => null, + 'recipient_id' => null, + 'recipient_id_guid' => null, + 'recipient_signature_providers' => null, + 'recipient_supplies_tabs' => null, + 'require_id_lookup' => null, + 'require_signer_certificate' => null, + 'require_sign_on_paper' => null, + 'role_name' => null, + 'routing_order' => null, + 'saml_authentication' => null, + 'sent_date_time' => null, + 'signature_info' => null, + 'signed_date_time' => null, + 'sign_in_each_location' => null, + 'signing_group_id' => null, + 'signing_group_name' => null, + 'signing_group_users' => null, + 'sms_authentication' => null, + 'social_authentications' => null, + 'status' => 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 = [ @@ -198,9 +291,9 @@ public static function swaggerTypes() 'witness_for_guid' => 'witnessForGuid' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -271,9 +364,9 @@ public static function swaggerTypes() 'witness_for_guid' => 'setWitnessForGuid' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -344,34 +437,63 @@ 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) { @@ -443,30 +565,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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() @@ -476,7 +600,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) @@ -488,6 +614,7 @@ public function setAccessCode($access_code) /** * Gets add_access_code_to_email + * * @return string */ public function getAddAccessCodeToEmail() @@ -497,7 +624,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) @@ -509,6 +638,7 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) /** * Gets agent_can_edit_email + * * @return string */ public function getAgentCanEditEmail() @@ -518,7 +648,9 @@ public function getAgentCanEditEmail() /** * Sets agent_can_edit_email + * * @param string $agent_can_edit_email + * * @return $this */ public function setAgentCanEditEmail($agent_can_edit_email) @@ -530,6 +662,7 @@ public function setAgentCanEditEmail($agent_can_edit_email) /** * Gets agent_can_edit_name + * * @return string */ public function getAgentCanEditName() @@ -539,7 +672,9 @@ public function getAgentCanEditName() /** * Sets agent_can_edit_name + * * @param string $agent_can_edit_name + * * @return $this */ public function setAgentCanEditName($agent_can_edit_name) @@ -551,6 +686,7 @@ public function setAgentCanEditName($agent_can_edit_name) /** * Gets auto_navigation + * * @return string */ public function getAutoNavigation() @@ -560,7 +696,9 @@ public function getAutoNavigation() /** * Sets auto_navigation + * * @param string $auto_navigation + * * @return $this */ public function setAutoNavigation($auto_navigation) @@ -572,6 +710,7 @@ public function setAutoNavigation($auto_navigation) /** * Gets bulk_recipients_uri + * * @return string */ public function getBulkRecipientsUri() @@ -581,7 +720,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) @@ -593,6 +734,7 @@ public function setBulkRecipientsUri($bulk_recipients_uri) /** * Gets can_sign_offline + * * @return string */ public function getCanSignOffline() @@ -602,7 +744,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) @@ -614,6 +758,7 @@ public function setCanSignOffline($can_sign_offline) /** * Gets client_user_id + * * @return string */ public function getClientUserId() @@ -623,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) @@ -635,6 +782,7 @@ public function setClientUserId($client_user_id) /** * Gets creation_reason + * * @return string */ public function getCreationReason() @@ -644,7 +792,9 @@ public function getCreationReason() /** * Sets creation_reason + * * @param string $creation_reason + * * @return $this */ public function setCreationReason($creation_reason) @@ -656,6 +806,7 @@ public function setCreationReason($creation_reason) /** * Gets custom_fields + * * @return string[] */ public function getCustomFields() @@ -665,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) @@ -677,6 +830,7 @@ public function setCustomFields($custom_fields) /** * Gets declined_date_time + * * @return string */ public function getDeclinedDateTime() @@ -686,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) @@ -698,6 +854,7 @@ public function setDeclinedDateTime($declined_date_time) /** * Gets declined_reason + * * @return string */ public function getDeclinedReason() @@ -707,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) @@ -719,6 +878,7 @@ public function setDeclinedReason($declined_reason) /** * Gets default_recipient + * * @return string */ public function getDefaultRecipient() @@ -728,7 +888,9 @@ public function getDefaultRecipient() /** * Sets default_recipient + * * @param string $default_recipient + * * @return $this */ public function setDefaultRecipient($default_recipient) @@ -740,6 +902,7 @@ public function setDefaultRecipient($default_recipient) /** * Gets delivered_date_time + * * @return string */ public function getDeliveredDateTime() @@ -749,7 +912,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) @@ -761,6 +926,7 @@ public function setDeliveredDateTime($delivered_date_time) /** * Gets delivery_method + * * @return string */ public function getDeliveryMethod() @@ -770,7 +936,9 @@ public function getDeliveryMethod() /** * Sets delivery_method + * * @param string $delivery_method Reserved: For DocuSign use only. + * * @return $this */ public function setDeliveryMethod($delivery_method) @@ -782,6 +950,7 @@ public function setDeliveryMethod($delivery_method) /** * Gets document_visibility + * * @return \DocuSign\eSign\Model\DocumentVisibility[] */ public function getDocumentVisibility() @@ -791,7 +960,9 @@ public function getDocumentVisibility() /** * Sets document_visibility + * * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * * @return $this */ public function setDocumentVisibility($document_visibility) @@ -803,6 +974,7 @@ public function setDocumentVisibility($document_visibility) /** * Gets email + * * @return string */ public function getEmail() @@ -812,7 +984,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -824,6 +998,7 @@ public function setEmail($email) /** * Gets email_notification + * * @return \DocuSign\eSign\Model\RecipientEmailNotification */ public function getEmailNotification() @@ -833,7 +1008,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) @@ -845,6 +1022,7 @@ public function setEmailNotification($email_notification) /** * Gets email_recipient_post_signing_url + * * @return string */ public function getEmailRecipientPostSigningUrl() @@ -854,7 +1032,9 @@ public function getEmailRecipientPostSigningUrl() /** * Sets email_recipient_post_signing_url + * * @param string $email_recipient_post_signing_url + * * @return $this */ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) @@ -866,6 +1046,7 @@ public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_ur /** * Gets embedded_recipient_start_url + * * @return string */ public function getEmbeddedRecipientStartUrl() @@ -875,7 +1056,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) @@ -887,6 +1070,7 @@ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -896,7 +1080,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) @@ -908,6 +1094,7 @@ public function setErrorDetails($error_details) /** * Gets excluded_documents + * * @return string[] */ public function getExcludedDocuments() @@ -917,7 +1104,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) @@ -929,6 +1118,7 @@ public function setExcludedDocuments($excluded_documents) /** * Gets fax_number + * * @return string */ public function getFaxNumber() @@ -938,7 +1128,9 @@ public function getFaxNumber() /** * Sets fax_number + * * @param string $fax_number Reserved: + * * @return $this */ public function setFaxNumber($fax_number) @@ -950,6 +1142,7 @@ public function setFaxNumber($fax_number) /** * Gets first_name + * * @return string */ public function getFirstName() @@ -959,7 +1152,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) @@ -971,6 +1166,7 @@ public function setFirstName($first_name) /** * Gets full_name + * * @return string */ public function getFullName() @@ -980,7 +1176,9 @@ public function getFullName() /** * Sets full_name + * * @param string $full_name + * * @return $this */ public function setFullName($full_name) @@ -992,6 +1190,7 @@ public function setFullName($full_name) /** * Gets id_check_configuration_name + * * @return string */ public function getIdCheckConfigurationName() @@ -1001,7 +1200,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) @@ -1013,6 +1214,7 @@ public function setIdCheckConfigurationName($id_check_configuration_name) /** * Gets id_check_information_input + * * @return \DocuSign\eSign\Model\IdCheckInformationInput */ public function getIdCheckInformationInput() @@ -1022,7 +1224,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) @@ -1034,6 +1238,7 @@ public function setIdCheckInformationInput($id_check_information_input) /** * Gets identity_verification + * * @return \DocuSign\eSign\Model\RecipientIdentityVerification */ public function getIdentityVerification() @@ -1043,7 +1248,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) @@ -1055,6 +1262,7 @@ public function setIdentityVerification($identity_verification) /** * Gets inherit_email_notification_configuration + * * @return string */ public function getInheritEmailNotificationConfiguration() @@ -1064,7 +1272,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) @@ -1076,6 +1286,7 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica /** * Gets is_bulk_recipient + * * @return string */ public function getIsBulkRecipient() @@ -1085,7 +1296,9 @@ public function getIsBulkRecipient() /** * Sets is_bulk_recipient + * * @param string $is_bulk_recipient + * * @return $this */ public function setIsBulkRecipient($is_bulk_recipient) @@ -1097,6 +1310,7 @@ public function setIsBulkRecipient($is_bulk_recipient) /** * Gets last_name + * * @return string */ public function getLastName() @@ -1106,7 +1320,9 @@ public function getLastName() /** * Sets last_name + * * @param string $last_name + * * @return $this */ public function setLastName($last_name) @@ -1118,6 +1334,7 @@ public function setLastName($last_name) /** * Gets name + * * @return string */ public function getName() @@ -1127,7 +1344,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -1139,6 +1358,7 @@ public function setName($name) /** * Gets note + * * @return string */ public function getNote() @@ -1148,7 +1368,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) @@ -1160,6 +1382,7 @@ public function setNote($note) /** * Gets offline_attributes + * * @return \DocuSign\eSign\Model\OfflineAttributes */ public function getOfflineAttributes() @@ -1169,7 +1392,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) @@ -1181,6 +1406,7 @@ public function setOfflineAttributes($offline_attributes) /** * Gets phone_authentication + * * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication */ public function getPhoneAuthentication() @@ -1190,7 +1416,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) @@ -1202,6 +1430,7 @@ public function setPhoneAuthentication($phone_authentication) /** * Gets proof_file + * * @return \DocuSign\eSign\Model\RecipientProofFile */ public function getProofFile() @@ -1211,7 +1440,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) @@ -1223,6 +1454,7 @@ public function setProofFile($proof_file) /** * Gets recipient_attachments + * * @return \DocuSign\eSign\Model\RecipientAttachment[] */ public function getRecipientAttachments() @@ -1232,7 +1464,9 @@ public function getRecipientAttachments() /** * Sets recipient_attachments + * * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * * @return $this */ public function setRecipientAttachments($recipient_attachments) @@ -1244,6 +1478,7 @@ public function setRecipientAttachments($recipient_attachments) /** * Gets recipient_authentication_status + * * @return \DocuSign\eSign\Model\AuthenticationStatus */ public function getRecipientAuthenticationStatus() @@ -1253,7 +1488,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) @@ -1265,6 +1502,7 @@ public function setRecipientAuthenticationStatus($recipient_authentication_statu /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -1274,7 +1512,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) @@ -1286,6 +1526,7 @@ public function setRecipientId($recipient_id) /** * Gets recipient_id_guid + * * @return string */ public function getRecipientIdGuid() @@ -1295,7 +1536,9 @@ public function getRecipientIdGuid() /** * Sets recipient_id_guid + * * @param string $recipient_id_guid + * * @return $this */ public function setRecipientIdGuid($recipient_id_guid) @@ -1307,6 +1550,7 @@ public function setRecipientIdGuid($recipient_id_guid) /** * Gets recipient_signature_providers + * * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] */ public function getRecipientSignatureProviders() @@ -1316,7 +1560,9 @@ public function getRecipientSignatureProviders() /** * Sets recipient_signature_providers + * * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * * @return $this */ public function setRecipientSignatureProviders($recipient_signature_providers) @@ -1328,6 +1574,7 @@ public function setRecipientSignatureProviders($recipient_signature_providers) /** * Gets recipient_supplies_tabs + * * @return string */ public function getRecipientSuppliesTabs() @@ -1337,7 +1584,9 @@ public function getRecipientSuppliesTabs() /** * Sets recipient_supplies_tabs + * * @param string $recipient_supplies_tabs + * * @return $this */ public function setRecipientSuppliesTabs($recipient_supplies_tabs) @@ -1349,6 +1598,7 @@ public function setRecipientSuppliesTabs($recipient_supplies_tabs) /** * Gets require_id_lookup + * * @return string */ public function getRequireIdLookup() @@ -1358,7 +1608,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) @@ -1370,6 +1622,7 @@ public function setRequireIdLookup($require_id_lookup) /** * Gets require_signer_certificate + * * @return string */ public function getRequireSignerCertificate() @@ -1379,7 +1632,9 @@ public function getRequireSignerCertificate() /** * Sets require_signer_certificate + * * @param string $require_signer_certificate + * * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) @@ -1391,6 +1646,7 @@ public function setRequireSignerCertificate($require_signer_certificate) /** * Gets require_sign_on_paper + * * @return string */ public function getRequireSignOnPaper() @@ -1400,7 +1656,9 @@ public function getRequireSignOnPaper() /** * Sets require_sign_on_paper + * * @param string $require_sign_on_paper + * * @return $this */ public function setRequireSignOnPaper($require_sign_on_paper) @@ -1412,6 +1670,7 @@ public function setRequireSignOnPaper($require_sign_on_paper) /** * Gets role_name + * * @return string */ public function getRoleName() @@ -1421,7 +1680,9 @@ public function getRoleName() /** * Sets role_name + * * @param string $role_name Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. + * * @return $this */ public function setRoleName($role_name) @@ -1433,6 +1694,7 @@ public function setRoleName($role_name) /** * Gets routing_order + * * @return string */ public function getRoutingOrder() @@ -1442,7 +1704,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) @@ -1454,6 +1718,7 @@ public function setRoutingOrder($routing_order) /** * Gets saml_authentication + * * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication */ public function getSamlAuthentication() @@ -1463,7 +1728,9 @@ public function getSamlAuthentication() /** * Sets saml_authentication - * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication saml_authentication + * * @return $this */ public function setSamlAuthentication($saml_authentication) @@ -1475,6 +1742,7 @@ public function setSamlAuthentication($saml_authentication) /** * Gets sent_date_time + * * @return string */ public function getSentDateTime() @@ -1484,7 +1752,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) @@ -1496,6 +1766,7 @@ public function setSentDateTime($sent_date_time) /** * Gets signature_info + * * @return \DocuSign\eSign\Model\RecipientSignatureInformation */ public function getSignatureInfo() @@ -1505,7 +1776,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) @@ -1517,6 +1790,7 @@ public function setSignatureInfo($signature_info) /** * Gets signed_date_time + * * @return string */ public function getSignedDateTime() @@ -1526,7 +1800,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) @@ -1538,6 +1814,7 @@ public function setSignedDateTime($signed_date_time) /** * Gets sign_in_each_location + * * @return string */ public function getSignInEachLocation() @@ -1547,7 +1824,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) @@ -1559,6 +1838,7 @@ public function setSignInEachLocation($sign_in_each_location) /** * Gets signing_group_id + * * @return string */ public function getSigningGroupId() @@ -1568,7 +1848,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) @@ -1580,6 +1862,7 @@ public function setSigningGroupId($signing_group_id) /** * Gets signing_group_name + * * @return string */ public function getSigningGroupName() @@ -1589,7 +1872,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) @@ -1601,6 +1886,7 @@ public function setSigningGroupName($signing_group_name) /** * Gets signing_group_users + * * @return \DocuSign\eSign\Model\UserInfo[] */ public function getSigningGroupUsers() @@ -1610,7 +1896,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) @@ -1622,6 +1910,7 @@ public function setSigningGroupUsers($signing_group_users) /** * Gets sms_authentication + * * @return \DocuSign\eSign\Model\RecipientSMSAuthentication */ public function getSmsAuthentication() @@ -1631,7 +1920,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) @@ -1643,6 +1934,7 @@ public function setSmsAuthentication($sms_authentication) /** * Gets social_authentications + * * @return \DocuSign\eSign\Model\SocialAuthentication[] */ public function getSocialAuthentications() @@ -1652,7 +1944,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) @@ -1664,6 +1958,7 @@ public function setSocialAuthentications($social_authentications) /** * Gets status + * * @return string */ public function getStatus() @@ -1673,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) @@ -1685,6 +1982,7 @@ public function setStatus($status) /** * Gets tabs + * * @return \DocuSign\eSign\Model\Tabs */ public function getTabs() @@ -1694,7 +1992,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) @@ -1706,6 +2006,7 @@ public function setTabs($tabs) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1715,7 +2016,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) @@ -1727,6 +2030,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1736,7 +2040,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) @@ -1748,6 +2054,7 @@ public function setTemplateRequired($template_required) /** * Gets total_tab_count + * * @return string */ public function getTotalTabCount() @@ -1757,7 +2064,9 @@ public function getTotalTabCount() /** * Sets total_tab_count + * * @param string $total_tab_count + * * @return $this */ public function setTotalTabCount($total_tab_count) @@ -1769,6 +2078,7 @@ public function setTotalTabCount($total_tab_count) /** * Gets user_id + * * @return string */ public function getUserId() @@ -1778,7 +2088,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -1790,6 +2102,7 @@ public function setUserId($user_id) /** * Gets witness_for + * * @return string */ public function getWitnessFor() @@ -1799,7 +2112,9 @@ public function getWitnessFor() /** * Sets witness_for + * * @param string $witness_for + * * @return $this */ public function setWitnessFor($witness_for) @@ -1811,6 +2126,7 @@ public function setWitnessFor($witness_for) /** * Gets witness_for_guid + * * @return string */ public function getWitnessForGuid() @@ -1820,7 +2136,9 @@ public function getWitnessForGuid() /** * Sets witness_for_guid + * * @param string $witness_for_guid + * * @return $this */ public function setWitnessForGuid($witness_for_guid) @@ -1831,7 +2149,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) @@ -1841,7 +2161,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1851,8 +2173,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1866,7 +2190,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1876,16 +2202,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + ObjectSerializer::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 da68e695..aa51d91b 100644 --- a/src/Model/Workspace.php +++ b/src/Model/Workspace.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -68,13 +71,49 @@ 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, + 'created' => null, + 'created_by_information' => null, + 'last_modified' => null, + 'last_modified_by_information' => 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 = [ @@ -91,9 +130,9 @@ public static function swaggerTypes() 'workspace_uri' => 'workspaceUri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -110,9 +149,9 @@ public static function swaggerTypes() 'workspace_uri' => 'setWorkspaceUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -129,34 +168,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) { @@ -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 billable_account_id + * * @return string */ public function getBillableAccountId() @@ -207,7 +277,9 @@ public function getBillableAccountId() /** * Sets billable_account_id + * * @param string $billable_account_id + * * @return $this */ public function setBillableAccountId($billable_account_id) @@ -219,6 +291,7 @@ public function setBillableAccountId($billable_account_id) /** * Gets created + * * @return string */ public function getCreated() @@ -228,7 +301,9 @@ public function getCreated() /** * Sets created + * * @param string $created + * * @return $this */ public function setCreated($created) @@ -240,6 +315,7 @@ public function setCreated($created) /** * Gets created_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getCreatedByInformation() @@ -249,7 +325,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) @@ -261,6 +339,7 @@ public function setCreatedByInformation($created_by_information) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -270,7 +349,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) @@ -282,6 +363,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getLastModifiedByInformation() @@ -291,7 +373,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) @@ -303,6 +387,7 @@ public function setLastModifiedByInformation($last_modified_by_information) /** * Gets status + * * @return string */ public function getStatus() @@ -312,7 +397,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) @@ -324,6 +411,7 @@ public function setStatus($status) /** * Gets workspace_base_url + * * @return string */ public function getWorkspaceBaseUrl() @@ -333,7 +421,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) @@ -345,6 +435,7 @@ public function setWorkspaceBaseUrl($workspace_base_url) /** * Gets workspace_description + * * @return string */ public function getWorkspaceDescription() @@ -354,7 +445,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) @@ -366,6 +459,7 @@ public function setWorkspaceDescription($workspace_description) /** * Gets workspace_id + * * @return string */ public function getWorkspaceId() @@ -375,7 +469,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) @@ -387,6 +483,7 @@ public function setWorkspaceId($workspace_id) /** * Gets workspace_name + * * @return string */ public function getWorkspaceName() @@ -396,7 +493,9 @@ public function getWorkspaceName() /** * Sets workspace_name + * * @param string $workspace_name The name of the workspace. + * * @return $this */ public function setWorkspaceName($workspace_name) @@ -408,6 +507,7 @@ public function setWorkspaceName($workspace_name) /** * Gets workspace_uri + * * @return string */ public function getWorkspaceUri() @@ -417,7 +517,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) @@ -428,7 +530,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) @@ -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/WorkspaceFolderContents.php b/src/Model/WorkspaceFolderContents.php index a5eddf23..a357af4f 100644 --- a/src/Model/WorkspaceFolderContents.php +++ b/src/Model/WorkspaceFolderContents.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 0dce0691..1c715637 100644 --- a/src/Model/WorkspaceItem.php +++ b/src/Model/WorkspaceItem.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -76,13 +79,57 @@ class WorkspaceItem implements ArrayAccess 'uri' => 'string' ]; + /** + * 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, + '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 = [ @@ -107,9 +154,9 @@ public static function swaggerTypes() 'uri' => 'uri' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -134,9 +181,9 @@ public static function swaggerTypes() 'uri' => 'setUri' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -161,34 +208,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) { @@ -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 caller_authorization + * * @return \DocuSign\eSign\Model\WorkspaceUserAuthorization */ public function getCallerAuthorization() @@ -247,7 +325,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) @@ -259,6 +339,7 @@ public function setCallerAuthorization($caller_authorization) /** * Gets content_type + * * @return string */ public function getContentType() @@ -268,7 +349,9 @@ public function getContentType() /** * Sets content_type + * * @param string $content_type + * * @return $this */ public function setContentType($content_type) @@ -280,6 +363,7 @@ public function setContentType($content_type) /** * Gets created + * * @return string */ public function getCreated() @@ -289,7 +373,9 @@ public function getCreated() /** * Sets created + * * @param string $created The UTC DateTime when the workspace item was created. + * * @return $this */ public function setCreated($created) @@ -301,6 +387,7 @@ public function setCreated($created) /** * Gets created_by_id + * * @return string */ public function getCreatedById() @@ -310,7 +397,9 @@ public function getCreatedById() /** * Sets created_by_id + * * @param string $created_by_id + * * @return $this */ public function setCreatedById($created_by_id) @@ -322,6 +411,7 @@ public function setCreatedById($created_by_id) /** * Gets created_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getCreatedByInformation() @@ -331,7 +421,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) @@ -343,6 +435,7 @@ public function setCreatedByInformation($created_by_information) /** * Gets extension + * * @return string */ public function getExtension() @@ -352,7 +445,9 @@ public function getExtension() /** * Sets extension + * * @param string $extension + * * @return $this */ public function setExtension($extension) @@ -364,6 +459,7 @@ public function setExtension($extension) /** * Gets file_size + * * @return string */ public function getFileSize() @@ -373,7 +469,9 @@ public function getFileSize() /** * Sets file_size + * * @param string $file_size + * * @return $this */ public function setFileSize($file_size) @@ -385,6 +483,7 @@ public function setFileSize($file_size) /** * Gets file_uri + * * @return string */ public function getFileUri() @@ -394,7 +493,9 @@ public function getFileUri() /** * Sets file_uri + * * @param string $file_uri + * * @return $this */ public function setFileUri($file_uri) @@ -406,6 +507,7 @@ public function setFileUri($file_uri) /** * Gets id + * * @return string */ public function getId() @@ -415,7 +517,9 @@ public function getId() /** * Sets id + * * @param string $id + * * @return $this */ public function setId($id) @@ -427,6 +531,7 @@ public function setId($id) /** * Gets is_public + * * @return string */ public function getIsPublic() @@ -436,7 +541,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) @@ -448,6 +555,7 @@ public function setIsPublic($is_public) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -457,7 +565,9 @@ public function getLastModified() /** * Sets last_modified + * * @param string $last_modified + * * @return $this */ public function setLastModified($last_modified) @@ -469,6 +579,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_id + * * @return string */ public function getLastModifiedById() @@ -478,7 +589,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) @@ -490,6 +603,7 @@ public function setLastModifiedById($last_modified_by_id) /** * Gets last_modified_by_information + * * @return \DocuSign\eSign\Model\WorkspaceUser */ public function getLastModifiedByInformation() @@ -499,7 +613,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) @@ -511,6 +627,7 @@ public function setLastModifiedByInformation($last_modified_by_information) /** * Gets name + * * @return string */ public function getName() @@ -520,7 +637,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) @@ -532,6 +651,7 @@ public function setName($name) /** * Gets page_count + * * @return string */ public function getPageCount() @@ -541,7 +661,9 @@ public function getPageCount() /** * Sets page_count + * * @param string $page_count + * * @return $this */ public function setPageCount($page_count) @@ -553,6 +675,7 @@ public function setPageCount($page_count) /** * Gets parent_folder_id + * * @return string */ public function getParentFolderId() @@ -562,7 +685,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) @@ -574,6 +699,7 @@ public function setParentFolderId($parent_folder_id) /** * Gets parent_folder_uri + * * @return string */ public function getParentFolderUri() @@ -583,7 +709,9 @@ public function getParentFolderUri() /** * Sets parent_folder_uri + * * @param string $parent_folder_uri + * * @return $this */ public function setParentFolderUri($parent_folder_uri) @@ -595,6 +723,7 @@ public function setParentFolderUri($parent_folder_uri) /** * Gets type + * * @return string */ public function getType() @@ -604,7 +733,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) @@ -616,6 +747,7 @@ public function setType($type) /** * Gets uri + * * @return string */ public function getUri() @@ -625,7 +757,9 @@ public function getUri() /** * Sets uri + * * @param string $uri + * * @return $this */ public function setUri($uri) @@ -636,7 +770,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) @@ -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/WorkspaceItemList.php b/src/Model/WorkspaceItemList.php index 0baaf94c..c409c084 100644 --- a/src/Model/WorkspaceItemList.php +++ b/src/Model/WorkspaceItemList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 b0f4af1e..2d2414dc 100644 --- a/src/Model/WorkspaceList.php +++ b/src/Model/WorkspaceList.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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/WorkspaceUser.php b/src/Model/WorkspaceUser.php index 0e8719ca..8513bc56 100644 --- a/src/Model/WorkspaceUser.php +++ b/src/Model/WorkspaceUser.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -73,13 +76,54 @@ class WorkspaceUser implements ArrayAccess 'workspace_user_id' => '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, + '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 + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ public static function swaggerTypes() { return self::$swaggerTypes; } /** - * Array of attributes where the key is the local name, and the value is the original name + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return 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() 'workspace_user_id' => 'workspaceUserId' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -125,9 +169,9 @@ public static function swaggerTypes() 'workspace_user_id' => 'setWorkspaceUserId' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -149,34 +193,63 @@ public static function swaggerTypes() 'workspace_user_id' => 'getWorkspaceUserId' ]; + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ public static function attributeMap() { return self::$attributeMap; } + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ public static function setters() { return self::$setters; } + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ public static function getters() { return self::$getters; } + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + /** * Associative array for storing property values + * * @var mixed[] */ protected $container = []; /** * Constructor - * @param mixed[] $data Associated 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 account_id + * * @return string */ public function getAccountId() @@ -232,7 +307,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) @@ -244,6 +321,7 @@ public function setAccountId($account_id) /** * Gets account_name + * * @return string */ public function getAccountName() @@ -253,7 +331,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) @@ -265,6 +345,7 @@ public function setAccountName($account_name) /** * Gets active_since + * * @return string */ public function getActiveSince() @@ -274,7 +355,9 @@ public function getActiveSince() /** * Sets active_since + * * @param string $active_since + * * @return $this */ public function setActiveSince($active_since) @@ -286,6 +369,7 @@ public function setActiveSince($active_since) /** * Gets created + * * @return string */ public function getCreated() @@ -295,7 +379,9 @@ public function getCreated() /** * Sets created + * * @param string $created The UTC DateTime when the workspace user was created. + * * @return $this */ public function setCreated($created) @@ -307,6 +393,7 @@ public function setCreated($created) /** * Gets created_by_id + * * @return string */ public function getCreatedById() @@ -316,7 +403,9 @@ public function getCreatedById() /** * Sets created_by_id + * * @param string $created_by_id + * * @return $this */ public function setCreatedById($created_by_id) @@ -328,6 +417,7 @@ public function setCreatedById($created_by_id) /** * Gets email + * * @return string */ public function getEmail() @@ -337,7 +427,9 @@ public function getEmail() /** * Sets email + * * @param string $email + * * @return $this */ public function setEmail($email) @@ -349,6 +441,7 @@ public function setEmail($email) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -358,7 +451,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) @@ -370,6 +465,7 @@ public function setErrorDetails($error_details) /** * Gets last_modified + * * @return string */ public function getLastModified() @@ -379,7 +475,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) @@ -391,6 +489,7 @@ public function setLastModified($last_modified) /** * Gets last_modified_by_id + * * @return string */ public function getLastModifiedById() @@ -400,7 +499,9 @@ public function getLastModifiedById() /** * Sets last_modified_by_id + * * @param string $last_modified_by_id + * * @return $this */ public function setLastModifiedById($last_modified_by_id) @@ -412,6 +513,7 @@ public function setLastModifiedById($last_modified_by_id) /** * Gets status + * * @return string */ public function getStatus() @@ -421,7 +523,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) @@ -433,6 +537,7 @@ public function setStatus($status) /** * Gets type + * * @return string */ public function getType() @@ -442,7 +547,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) @@ -454,6 +561,7 @@ public function setType($type) /** * Gets user_id + * * @return string */ public function getUserId() @@ -463,7 +571,9 @@ public function getUserId() /** * Sets user_id + * * @param string $user_id + * * @return $this */ public function setUserId($user_id) @@ -475,6 +585,7 @@ public function setUserId($user_id) /** * Gets user_name + * * @return string */ public function getUserName() @@ -484,7 +595,9 @@ public function getUserName() /** * Sets user_name + * * @param string $user_name + * * @return $this */ public function setUserName($user_name) @@ -496,6 +609,7 @@ public function setUserName($user_name) /** * Gets workspace_id + * * @return string */ public function getWorkspaceId() @@ -505,7 +619,9 @@ public function getWorkspaceId() /** * Sets workspace_id + * * @param string $workspace_id + * * @return $this */ public function setWorkspaceId($workspace_id) @@ -517,6 +633,7 @@ public function setWorkspaceId($workspace_id) /** * Gets workspace_user_base_url + * * @return string */ public function getWorkspaceUserBaseUrl() @@ -526,7 +643,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) @@ -538,6 +657,7 @@ public function setWorkspaceUserBaseUrl($workspace_user_base_url) /** * Gets workspace_user_id + * * @return string */ public function getWorkspaceUserId() @@ -547,7 +667,9 @@ public function getWorkspaceUserId() /** * Sets workspace_user_id + * * @param string $workspace_user_id + * * @return $this */ public function setWorkspaceUserId($workspace_user_id) @@ -558,7 +680,9 @@ public function setWorkspaceUserId($workspace_user_id) } /** * 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/WorkspaceUserAuthorization.php b/src/Model/WorkspaceUserAuthorization.php index d6396523..38a60e9a 100644 --- a/src/Model/WorkspaceUserAuthorization.php +++ b/src/Model/WorkspaceUserAuthorization.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 6e29cb76..f7d7ad7f 100644 --- a/src/Model/Zip.php +++ b/src/Model/Zip.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/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 = [ @@ -104,13 +107,86 @@ class Zip implements ArrayAccess 'y_position' => 'string' ]; + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'anchor_case_sensitive' => null, + 'anchor_horizontal_alignment' => null, + 'anchor_ignore_if_not_present' => null, + 'anchor_match_whole_word' => null, + 'anchor_string' => null, + 'anchor_units' => null, + 'anchor_x_offset' => null, + 'anchor_y_offset' => null, + 'bold' => null, + 'conceal_value_on_document' => null, + 'conditional_parent_label' => null, + 'conditional_parent_value' => null, + 'custom_tab_id' => null, + 'disable_auto_size' => null, + 'document_id' => null, + 'error_details' => null, + 'font' => null, + 'font_color' => null, + 'font_size' => null, + 'italic' => null, + 'locked' => null, + 'max_length' => 'int32', + 'merge_field' => null, + 'name' => null, + 'original_value' => null, + 'page_number' => null, + 'recipient_id' => null, + 'require_all' => null, + 'required' => null, + 'require_initial_on_shared_change' => null, + 'sender_required' => null, + 'shared' => null, + 'status' => null, + 'tab_group_labels' => null, + 'tab_id' => null, + 'tab_label' => null, + 'tab_order' => null, + 'template_locked' => null, + 'template_required' => null, + 'tooltip' => null, + 'underline' => null, + 'use_dash4' => null, + 'validation_message' => null, + 'validation_pattern' => null, + 'value' => null, + 'width' => 'int32', + '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 = [ @@ -164,9 +240,9 @@ public static function swaggerTypes() 'y_position' => 'yPosition' ]; - /** * Array of attributes to setter functions (for deserialization of responses) + * * @var string[] */ protected static $setters = [ @@ -220,9 +296,9 @@ public static function swaggerTypes() 'y_position' => 'setYPosition' ]; - /** * Array of attributes to getter functions (for serialization of requests) + * * @var string[] */ protected static $getters = [ @@ -276,34 +352,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) { @@ -358,30 +463,32 @@ public function __construct(array $data = null) } /** - * show all the invalid properties with reasons. + * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { - $invalid_properties = []; - return $invalid_properties; + $invalidProperties = []; + + return $invalidProperties; } /** - * validate all the properties in the model + * Validate all the properties in the model * return true if all passed * - * @return bool True 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_case_sensitive + * * @return string */ public function getAnchorCaseSensitive() @@ -391,7 +498,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) @@ -403,6 +512,7 @@ public function setAnchorCaseSensitive($anchor_case_sensitive) /** * Gets anchor_horizontal_alignment + * * @return string */ public function getAnchorHorizontalAlignment() @@ -412,7 +522,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) @@ -424,6 +536,7 @@ public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) /** * Gets anchor_ignore_if_not_present + * * @return string */ public function getAnchorIgnoreIfNotPresent() @@ -433,7 +546,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) @@ -445,6 +560,7 @@ public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) /** * Gets anchor_match_whole_word + * * @return string */ public function getAnchorMatchWholeWord() @@ -454,7 +570,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) @@ -466,6 +584,7 @@ public function setAnchorMatchWholeWord($anchor_match_whole_word) /** * Gets anchor_string + * * @return string */ public function getAnchorString() @@ -475,7 +594,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) @@ -487,6 +608,7 @@ public function setAnchorString($anchor_string) /** * Gets anchor_units + * * @return string */ public function getAnchorUnits() @@ -496,7 +618,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) @@ -508,6 +632,7 @@ public function setAnchorUnits($anchor_units) /** * Gets anchor_x_offset + * * @return string */ public function getAnchorXOffset() @@ -517,7 +642,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) @@ -529,6 +656,7 @@ public function setAnchorXOffset($anchor_x_offset) /** * Gets anchor_y_offset + * * @return string */ public function getAnchorYOffset() @@ -538,7 +666,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) @@ -550,6 +680,7 @@ public function setAnchorYOffset($anchor_y_offset) /** * Gets bold + * * @return string */ public function getBold() @@ -559,7 +690,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) @@ -571,6 +704,7 @@ public function setBold($bold) /** * Gets conceal_value_on_document + * * @return string */ public function getConcealValueOnDocument() @@ -580,7 +714,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) @@ -592,6 +728,7 @@ public function setConcealValueOnDocument($conceal_value_on_document) /** * Gets conditional_parent_label + * * @return string */ public function getConditionalParentLabel() @@ -601,7 +738,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) @@ -613,6 +752,7 @@ public function setConditionalParentLabel($conditional_parent_label) /** * Gets conditional_parent_value + * * @return string */ public function getConditionalParentValue() @@ -622,7 +762,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) @@ -634,6 +776,7 @@ public function setConditionalParentValue($conditional_parent_value) /** * Gets custom_tab_id + * * @return string */ public function getCustomTabId() @@ -643,7 +786,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) @@ -655,6 +800,7 @@ public function setCustomTabId($custom_tab_id) /** * Gets disable_auto_size + * * @return string */ public function getDisableAutoSize() @@ -664,7 +810,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) @@ -676,6 +824,7 @@ public function setDisableAutoSize($disable_auto_size) /** * Gets document_id + * * @return string */ public function getDocumentId() @@ -685,7 +834,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) @@ -697,6 +848,7 @@ public function setDocumentId($document_id) /** * Gets error_details + * * @return \DocuSign\eSign\Model\ErrorDetails */ public function getErrorDetails() @@ -706,7 +858,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) @@ -718,6 +872,7 @@ public function setErrorDetails($error_details) /** * Gets font + * * @return string */ public function getFont() @@ -727,7 +882,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) @@ -739,6 +896,7 @@ public function setFont($font) /** * Gets font_color + * * @return string */ public function getFontColor() @@ -748,7 +906,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) @@ -760,6 +920,7 @@ public function setFontColor($font_color) /** * Gets font_size + * * @return string */ public function getFontSize() @@ -769,7 +930,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) @@ -781,6 +944,7 @@ public function setFontSize($font_size) /** * Gets italic + * * @return string */ public function getItalic() @@ -790,7 +954,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) @@ -802,6 +968,7 @@ public function setItalic($italic) /** * Gets locked + * * @return string */ public function getLocked() @@ -811,7 +978,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) @@ -823,6 +992,7 @@ public function setLocked($locked) /** * Gets max_length + * * @return int */ public function getMaxLength() @@ -832,7 +1002,9 @@ public function getMaxLength() /** * Sets max_length + * * @param int $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) @@ -844,6 +1016,7 @@ public function setMaxLength($max_length) /** * Gets merge_field + * * @return \DocuSign\eSign\Model\MergeField */ public function getMergeField() @@ -853,7 +1026,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) @@ -865,6 +1040,7 @@ public function setMergeField($merge_field) /** * Gets name + * * @return string */ public function getName() @@ -874,7 +1050,9 @@ public function getName() /** * Sets name + * * @param string $name + * * @return $this */ public function setName($name) @@ -886,6 +1064,7 @@ public function setName($name) /** * Gets original_value + * * @return string */ public function getOriginalValue() @@ -895,7 +1074,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) @@ -907,6 +1088,7 @@ public function setOriginalValue($original_value) /** * Gets page_number + * * @return string */ public function getPageNumber() @@ -916,7 +1098,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) @@ -928,6 +1112,7 @@ public function setPageNumber($page_number) /** * Gets recipient_id + * * @return string */ public function getRecipientId() @@ -937,7 +1122,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) @@ -949,6 +1136,7 @@ public function setRecipientId($recipient_id) /** * Gets require_all + * * @return string */ public function getRequireAll() @@ -958,7 +1146,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) @@ -970,6 +1160,7 @@ public function setRequireAll($require_all) /** * Gets required + * * @return string */ public function getRequired() @@ -979,7 +1170,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) @@ -991,6 +1184,7 @@ public function setRequired($required) /** * Gets require_initial_on_shared_change + * * @return string */ public function getRequireInitialOnSharedChange() @@ -1000,7 +1194,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) @@ -1012,6 +1208,7 @@ public function setRequireInitialOnSharedChange($require_initial_on_shared_chang /** * Gets sender_required + * * @return string */ public function getSenderRequired() @@ -1021,7 +1218,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) @@ -1033,6 +1232,7 @@ public function setSenderRequired($sender_required) /** * Gets shared + * * @return string */ public function getShared() @@ -1042,7 +1242,9 @@ public function getShared() /** * Sets shared + * * @param string $shared When set to **true**, this custom tab is shared. + * * @return $this */ public function setShared($shared) @@ -1054,6 +1256,7 @@ public function setShared($shared) /** * Gets status + * * @return string */ public function getStatus() @@ -1063,7 +1266,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) @@ -1075,6 +1280,7 @@ public function setStatus($status) /** * Gets tab_group_labels + * * @return string[] */ public function getTabGroupLabels() @@ -1084,7 +1290,9 @@ public function getTabGroupLabels() /** * Sets tab_group_labels + * * @param string[] $tab_group_labels + * * @return $this */ public function setTabGroupLabels($tab_group_labels) @@ -1096,6 +1304,7 @@ public function setTabGroupLabels($tab_group_labels) /** * Gets tab_id + * * @return string */ public function getTabId() @@ -1105,7 +1314,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) @@ -1117,6 +1328,7 @@ public function setTabId($tab_id) /** * Gets tab_label + * * @return string */ public function getTabLabel() @@ -1126,7 +1338,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) @@ -1138,6 +1352,7 @@ public function setTabLabel($tab_label) /** * Gets tab_order + * * @return string */ public function getTabOrder() @@ -1147,7 +1362,9 @@ public function getTabOrder() /** * Sets tab_order + * * @param string $tab_order + * * @return $this */ public function setTabOrder($tab_order) @@ -1159,6 +1376,7 @@ public function setTabOrder($tab_order) /** * Gets template_locked + * * @return string */ public function getTemplateLocked() @@ -1168,7 +1386,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) @@ -1180,6 +1400,7 @@ public function setTemplateLocked($template_locked) /** * Gets template_required + * * @return string */ public function getTemplateRequired() @@ -1189,7 +1410,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) @@ -1201,6 +1424,7 @@ public function setTemplateRequired($template_required) /** * Gets tooltip + * * @return string */ public function getTooltip() @@ -1210,7 +1434,9 @@ public function getTooltip() /** * Sets tooltip + * * @param string $tooltip + * * @return $this */ public function setTooltip($tooltip) @@ -1222,6 +1448,7 @@ public function setTooltip($tooltip) /** * Gets underline + * * @return string */ public function getUnderline() @@ -1231,7 +1458,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) @@ -1243,6 +1472,7 @@ public function setUnderline($underline) /** * Gets use_dash4 + * * @return string */ public function getUseDash4() @@ -1252,7 +1482,9 @@ public function getUseDash4() /** * Sets use_dash4 + * * @param string $use_dash4 + * * @return $this */ public function setUseDash4($use_dash4) @@ -1264,6 +1496,7 @@ public function setUseDash4($use_dash4) /** * Gets validation_message + * * @return string */ public function getValidationMessage() @@ -1273,7 +1506,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) @@ -1285,6 +1520,7 @@ public function setValidationMessage($validation_message) /** * Gets validation_pattern + * * @return string */ public function getValidationPattern() @@ -1294,7 +1530,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) @@ -1306,6 +1544,7 @@ public function setValidationPattern($validation_pattern) /** * Gets value + * * @return string */ public function getValue() @@ -1315,7 +1554,9 @@ public function getValue() /** * Sets value + * * @param string $value Specifies the value of the tab. + * * @return $this */ public function setValue($value) @@ -1327,6 +1568,7 @@ public function setValue($value) /** * Gets width + * * @return int */ public function getWidth() @@ -1336,7 +1578,9 @@ public function getWidth() /** * Sets width + * * @param int $width Width of the tab in pixels. + * * @return $this */ public function setWidth($width) @@ -1348,6 +1592,7 @@ public function setWidth($width) /** * Gets x_position + * * @return string */ public function getXPosition() @@ -1357,7 +1602,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) @@ -1369,6 +1616,7 @@ public function setXPosition($x_position) /** * Gets y_position + * * @return string */ public function getYPosition() @@ -1378,7 +1626,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) @@ -1389,7 +1639,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) @@ -1399,7 +1651,9 @@ public function offsetExists($offset) /** * Gets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return mixed */ public function offsetGet($offset) @@ -1409,8 +1663,10 @@ public function offsetGet($offset) /** * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * * @return void */ public function offsetSet($offset, $value) @@ -1424,7 +1680,9 @@ public function offsetSet($offset, $value) /** * Unsets offset. - * @param integer $offset Offset + * + * @param integer $offset Offset + * * @return void */ public function offsetUnset($offset) @@ -1434,16 +1692,19 @@ public function offsetUnset($offset) /** * Gets the string presentation of the object + * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + return json_encode( + 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 8f0a7cf8..053e4d35 100644 --- a/src/ObjectSerializer.php +++ b/src/ObjectSerializer.php @@ -18,7 +18,7 @@ * OpenAPI spec version: v2 * 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;